Op_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 Op
00017 //! @{
00018 
00019 
00020 //! Class for storing data required for delayed unary operations,
00021 //! such as the operand (e.g. the matrix to which the operation is to be applied) and the unary operator (e.g. inverse).
00022 //! The operand is stored as a reference (which can be optimised away),
00023 //! while the operator is "stored" through the template definition (op_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 one matrix can be stored.
00026 //!
00027 //! For example, we could have:
00028 //! Op< Glue< Mat, Mat, glue_times >, op_trans >
00029 
00030 template<typename T1, typename op_type>
00031 class Op : public Base<typename T1::elem_type, Op<T1, op_type> >
00032   {
00033   public:
00034   
00035   typedef typename T1::elem_type elem_type;
00036   typedef typename get_pod_type<elem_type>::pod_type pod_type;
00037 
00038 
00039   inline explicit Op(const T1& in_m);
00040   inline          Op(const T1& in_m, const elem_type in_aux);
00041   inline          Op(const T1& in_m, const u32 in_aux_u32_a, const u32 in_aux_u32_b);
00042   inline          Op(const u32 in_aux_u32_a, const u32 in_aux_u32_b, const char junk);
00043   inline         ~Op();
00044     
00045   
00046   const T1&       m;          //!< storage of reference to the operand (e.g. a matrix)
00047   const elem_type aux;        //!< storage of auxilliary data, user defined format
00048   const u32       aux_u32_a;  //!< storage of auxilliary data, u32 format
00049   const u32       aux_u32_b;  //!< storage of auxilliary data, u32 format
00050   
00051   };
00052 
00053 //! @}