Glue_proto.hpp

Go to the documentation of this file.
00001 // Copyright (C) 2009 NICTA
00002 // 
00003 // Authors:
00004 // - Conrad Sanderson (conradsand at ieee dot org)
00005 // 
00006 // This file is part of the Armadillo C++ library.
00007 // It is provided without any warranty of fitness
00008 // for any purpose. You can redistribute this file
00009 // and/or modify it under the terms of the GNU
00010 // Lesser General Public License (LGPL) as published
00011 // by the Free Software Foundation, either version 3
00012 // of the License or (at your option) any later version.
00013 // (see http://www.opensource.org/licenses for more info)
00014 
00015 
00016 //! \addtogroup Glue
00017 //! @{
00018 
00019 
00020 //! Class for storing data required for delayed binary operations,
00021 //! such as the operands (e.g. two matrices) and the binary operator (e.g. addition).
00022 //! The operands are stored as references (which can be optimised away),
00023 //! while the operator is "stored" through the template definition (glue_type).
00024 //! The operands can be 'Mat', 'Row', 'Col', 'Op', and 'Glue'.
00025 //! Note that as 'Glue' can be one of the operands, more than two matrices can be stored.
00026 //!
00027 //! For example, we could have: Glue< Glue<Mat, Mat, glue_times>, Mat, glue_plus>
00028 //! 
00029 //! Another example is: Glue< Op<Mat, op_trans>, Op<Mat, op_inv>, glue_times >
00030 //!
00031 //! More complicated example: Glue< Op< Glue<Mat, Mat, glue_plus>, op_trans>, Op<Mat, op_inv>, glue_times >
00032 //! 
00033 
00034 template<typename T1, typename T2, typename glue_type>
00035 class Glue : public Base<typename T1::elem_type, Glue<T1, T2, glue_type> >
00036   {
00037   public:
00038   
00039   typedef typename T1::elem_type elem_type;
00040   typedef typename get_pod_type<elem_type>::pod_type pod_type;
00041 
00042   arma_inline  Glue(const T1& in_A, const T2& in_B);
00043   arma_inline ~Glue();
00044   
00045   const T1& A;  //!< first operand
00046   const T2& B;  //!< second operand
00047   
00048   };
00049 
00050 
00051 //! @}