libs/geometry/doc/generated/transform_matrix_transformer.qbk

   1 [/============================================================================
   2   Boost.Geometry (aka GGL, Generic Geometry Library)
   3
   4   Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
   5   Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
   6   Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
   7
   8   Use, modification and distribution is subject to the Boost Software License,
   9   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  10   http://www.boost.org/LICENSE_1_0.txt)
  11 =============================================================================/]
  12
  13
  14 [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  15 [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1matrix__transformer.xml]
  16 [section:strategy_transform_matrix_transformer strategy::transform::matrix_transformer]
  17
  18 '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>transform</primary></indexterm><indexterm><primary>matrix_transformer</primary></indexterm>'''
  19 Affine transformation strategy in Cartesian system.
  20
  21 [heading Description]
  22 The strategy serves as a generic definition of an affine transformation matrix and procedure for applying it to a given point.
  23
  24 [heading Synopsis]
  25 ``template<typename CalculationType, std::size_t Dimension1, std::size_t Dimension2>
  26 class strategy::transform::matrix_transformer
  27       : public strategy::transform::detail::matrix_transformer::matrix_transformer< CalculationType, Dimension1, Dimension2 >
  28 {
  29   // ...
  30 };
  31 ``
  32
  33 [heading Template parameter(s)]
  34 [table
  35 [[Parameter] [Description]]
  36 [[typename CalculationType] []]
  37 [[std::size_t Dimension1] [number of dimensions to transform from ]]
  38 [[std::size_t Dimension2] [number of dimensions to transform to ]]
  39 ]
  40
  41 [heading Constructor(s)]
  42 [table
  43 [[Function] [Description] [Parameters] ]
  44 [[``template<typename Matrix>
  45 matrix_transformer(Matrix const & matrix)``
  46
  47 ] [] [[* Matrix const &]: ['matrix]:
  48
  49
  50
  51 ]]
  52 [[``matrix_transformer()``
  53
  54 ] [] [
  55
  56 ]]
  57 ]
  58
  59 [heading Header]
  60 `#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
  61
  62 [endsect]
  63