Op_proto.hpp

Go to the documentation of this file.
00001 // Copyright (C) 2010 NICTA and the authors listed below
00002 // http://nicta.com.au
00003 // 
00004 // Authors:
00005 // - Conrad Sanderson (conradsand at ieee dot org)
00006 // 
00007 // This file is part of the Armadillo C++ library.
00008 // It is provided without any warranty of fitness
00009 // for any purpose. You can redistribute this file
00010 // and/or modify it under the terms of the GNU
00011 // Lesser General Public License (LGPL) as published
00012 // by the Free Software Foundation, either version 3
00013 // of the License or (at your option) any later version.
00014 // (see http://www.opensource.org/licenses for more info)
00015 
00016 
00017 //! \addtogroup Op
00018 //! @{
00019 
00020 
00021 
00022 //! Class for storing data required for delayed unary operations,
00023 //! such as the operand (e.g. the matrix to which the operation is to be applied) and the unary operator (e.g. inverse).
00024 //! The operand is stored as a reference (which can be optimised away),
00025 //! while the operator is "stored" through the template definition (op_type).
00026 //! The operands can be 'Mat', 'Row', 'Col', 'Op', and 'Glue'.
00027 //! Note that as 'Glue' can be one of the operands, more than one matrix can be stored.
00028 //!
00029 //! For example, we could have:
00030 //! Op< Glue< Mat, Mat, glue_times >, op_trans >
00031 
00032 template<typename T1, typename op_type>
00033 class Op : public Base<typename T1::elem_type, Op<T1, op_type> >
00034   {
00035   public:
00036   
00037   typedef typename T1::elem_type                   elem_type;
00038   typedef typename get_pod_type<elem_type>::result pod_type;
00039 
00040   inline explicit Op(const T1& in_m);
00041   inline          Op(const T1& in_m, const elem_type in_aux);
00042   inline          Op(const T1& in_m, const u32 in_aux_u32_a, const u32 in_aux_u32_b);
00043   inline          Op(const T1& in_m, const elem_type in_aux, const u32 in_aux_u32_a, const u32 in_aux_u32_b);
00044   inline         ~Op();
00045     
00046   
00047   const T1&       m;          //!< storage of reference to the operand (e.g. a matrix)
00048   const elem_type aux;        //!< storage of auxiliary data, user defined format
00049   const u32       aux_u32_a;  //!< storage of auxiliary data, u32 format
00050   const u32       aux_u32_b;  //!< storage of auxiliary data, u32 format
00051   
00052   };
00053 
00054 
00055 
00056 //! @}