[/============================================================================ Boost.Geometry (aka GGL, Generic Geometry Library) Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. Copyright (c) 2008-2013 Bruno Lalande, Paris, France. Copyright (c) 2009-2013 Mateusz Loskot, London, UK. Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) =============================================================================/] [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] [/ Generated from doxy/doxygen_output/xml/group__arithmetic.xml] [section:add_point add_point] '''add_point''' Adds a point to another. [heading Description] The coordinates of the second point will be added to those of the first point. The second point is not modified. [heading Synopsis] ``template void add_point(Point1 & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:add_value add_value] '''add_value''' Adds the same value to each coordinate of a point. [heading Synopsis] ``template void add_value(Point & p, typename detail::param< Point >::type value)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point &] [Any type fulfilling a Point Concept ] [p] [point ]] [[typename detail::param< Point >::type] [] [value] [value to add ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:assign_point assign_point] '''assign_point''' Assign a point with another. [heading Description] The coordinates of the first point will be assigned those of the second point. The second point is not modified. [heading Synopsis] ``template void assign_point(Point1 & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:assign_value assign_value] '''assign_value''' Assign each coordinate of a point the same value. [heading Synopsis] ``template void assign_value(Point & p, typename detail::param< Point >::type value)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point &] [Any type fulfilling a Point Concept ] [p] [point ]] [[typename detail::param< Point >::type] [] [value] [value to assign ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:cross_product_2 cross_product] '''cross_product''' Computes the cross product of two vectors. [heading Description] All vectors should have the same dimension, 3 or 2. [heading Synopsis] ``template ResultP cross_product(P1 const & p1, P2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[ResultP] [] [ - ] [Must be specified]] [[P1 const &] [] [p1] [first vector ]] [[P2 const &] [] [p2] [second vector ]] ] [heading Returns] the cross product vector [heading Header] `#include ` [endsect] [section:cross_product_2 cross_product] '''cross_product''' Computes the cross product of two vectors. [heading Description] All vectors should have the same dimension, 3 or 2. [heading Synopsis] ``template P cross_product(P const & p1, P const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[P const &] [] [p1] [first vector ]] [[P const &] [] [p2] [second vector ]] ] [heading Returns] the cross product vector [heading Header] `#include ` [heading Examples] [cross_product] [cross_product_output] [endsect] [section:divide_point divide_point] '''divide_point''' Divides a point by another. [heading Description] The coordinates of the first point will be divided by those of the second point. The second point is not modified. [heading Synopsis] ``template void divide_point(Point1 & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:divide_value divide_value] '''divide_value''' Divides each coordinate of the same point by a value. [heading Synopsis] ``template void divide_value(Point & p, typename detail::param< Point >::type value)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point &] [Any type fulfilling a Point Concept ] [p] [point ]] [[typename detail::param< Point >::type] [] [value] [value to divide by ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:dot_product dot_product] '''dot_product''' Computes the dot product (or scalar product) of 2 vectors (points). [heading Synopsis] ``template select_coordinate_type::type dot_product(Point1 const & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 const &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Returns] the dot product [heading Header] Either `#include ` Or `#include ` [heading Examples] [dot_product] [dot_product_output] [endsect] [section:multiply_point multiply_point] '''multiply_point''' Multiplies a point by another. [heading Description] The coordinates of the first point will be multiplied by those of the second point. The second point is not modified. [heading Synopsis] ``template void multiply_point(Point1 & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:multiply_value multiply_value] '''multiply_value''' Multiplies each coordinate of a point by the same value. [heading Synopsis] ``template void multiply_value(Point & p, typename detail::param< Point >::type value)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point &] [Any type fulfilling a Point Concept ] [p] [point ]] [[typename detail::param< Point >::type] [] [value] [value to multiply by ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:subtract_point subtract_point] '''subtract_point''' Subtracts a point to another. [heading Description] The coordinates of the second point will be subtracted to those of the first point. The second point is not modified. [heading Synopsis] ``template void subtract_point(Point1 & p1, Point2 const & p2)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point1 &] [Any type fulfilling a Point Concept ] [p1] [first point ]] [[Point2 const &] [Any type fulfilling a Point Concept ] [p2] [second point ]] ] [heading Header] Either `#include ` Or `#include ` [endsect] [section:subtract_value subtract_value] '''subtract_value''' Subtracts the same value to each coordinate of a point. [heading Synopsis] ``template void subtract_value(Point & p, typename detail::param< Point >::type value)`` [heading Parameters] [table [[Type] [Concept] [Name] [Description] ] [[Point &] [Any type fulfilling a Point Concept ] [p] [point ]] [[typename detail::param< Point >::type] [] [value] [value to subtract ]] ] [heading Header] Either `#include ` Or `#include ` [endsect]