OpCube_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 OpCube
00017 //! @{
00018 
00019 
00020 //! Analog of the Op class, intended for cubes
00021 
00022 template<typename T1, typename op_type>
00023 class OpCube : public BaseCube<typename T1::elem_type, OpCube<T1, op_type> >
00024   {
00025   public:
00026   
00027   typedef typename T1::elem_type elem_type;
00028   typedef typename get_pod_type<elem_type>::pod_type pod_type;
00029   
00030   
00031   inline explicit OpCube(const BaseCube<typename T1::elem_type, T1>& in_m);
00032   inline          OpCube(const BaseCube<typename T1::elem_type, T1>& in_m, const elem_type in_aux);
00033   inline          OpCube(const BaseCube<typename T1::elem_type, T1>& in_m, const u32 in_aux_u32_a, const u32 in_aux_u32_b);
00034   inline          OpCube(const BaseCube<typename T1::elem_type, T1>& in_m, const u32 in_aux_u32_a, const u32 in_aux_u32_b, const u32 in_aux_u32_c);
00035   inline          OpCube(const BaseCube<typename T1::elem_type, T1>& in_m, const elem_type in_aux, const u32 in_aux_u32_a, const u32 in_aux_u32_b, const u32 in_aux_u32_c);
00036   inline          OpCube(const u32 in_aux_u32_a, const u32 in_aux_u32_b, const u32 in_aux_u32_c);
00037   inline         ~OpCube();
00038   
00039   // TODO:MAT: if the restriction to inputs of type BaseCube works, the use of the "junk" parameter may no longer be necessary
00040 
00041   const T1&       m;          //!< storage of reference to the operand (e.g. a cube)
00042   const elem_type aux;        //!< storage of auxiliary data, user defined format
00043   const u32       aux_u32_a;  //!< storage of auxiliary data, u32 format
00044   const u32       aux_u32_b;  //!< storage of auxiliary data, u32 format
00045   const u32       aux_u32_c;  //!< storage of auxiliary data, u32 format
00046   
00047   };
00048 
00049 
00050 
00051 //! @}