Warning: this documentation for the development version is under construction.

/home/vivien/public_html/.src_seldon/matrix/Matrix_HermPacked.hxx

00001 // Copyright (C) 2001-2009 Vivien Mallet
00002 // Copyright (C) 2003-2009 Marc Duruflé
00003 //
00004 // This file is part of the linear-algebra library Seldon,
00005 // http://seldon.sourceforge.net/.
00006 //
00007 // Seldon is free software; you can redistribute it and/or modify it under the
00008 // terms of the GNU Lesser General Public License as published by the Free
00009 // Software Foundation; either version 2.1 of the License, or (at your option)
00010 // any later version.
00011 //
00012 // Seldon is distributed in the hope that it will be useful, but WITHOUT ANY
00013 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
00015 // more details.
00016 //
00017 // You should have received a copy of the GNU Lesser General Public License
00018 // along with Seldon. If not, see http://www.gnu.org/licenses/.
00019 
00020 
00021 // To be included by Seldon.hxx
00022 
00023 #ifndef SELDON_FILE_MATRIX_HERMPACKED_HXX
00024 
00025 #include "../share/Common.hxx"
00026 #include "../share/Properties.hxx"
00027 #include "../share/Storage.hxx"
00028 #include "../share/Errors.hxx"
00029 #include "../share/Allocator.hxx"
00030 
00031 namespace Seldon
00032 {
00033 
00034 
00036   template <class T, class Prop, class Storage,
00037             class Allocator = SELDON_DEFAULT_ALLOCATOR<T> >
00038   class Matrix_HermPacked: public Matrix_Base<T, Allocator>
00039   {
00040     // typedef declaration.
00041   public:
00042     typedef typename Allocator::value_type value_type;
00043     typedef typename Allocator::pointer pointer;
00044     typedef typename Allocator::const_pointer const_pointer;
00045     typedef typename Allocator::reference reference;
00046     typedef typename Allocator::const_reference const_reference;
00047     typedef typename Allocator::value_type entry_type;
00048     typedef typename Allocator::reference access_type;
00049     typedef typename Allocator::const_reference const_access_type;
00050 
00051     // Attributes.
00052   protected:
00053 
00054     // Methods.
00055   public:
00056     // Constructor.
00057     Matrix_HermPacked();
00058     Matrix_HermPacked(int i, int j = 0);
00059     Matrix_HermPacked(const Matrix_HermPacked<T, Prop,
00060                       Storage, Allocator>& A);
00061 
00062     // Destructor.
00063     ~Matrix_HermPacked();
00064     void Clear();
00065 
00066     // Basic methods.
00067     int GetDataSize() const;
00068 
00069     // Memory management.
00070     void Reallocate(int i, int j);
00071     void SetData(int i, int j, pointer data);
00072     void Nullify();
00073 
00074     // Element access and affectation.
00075     value_type operator() (int i, int j) const;
00076     reference Val(int i, int j);
00077     const_reference Val(int i, int j) const;
00078     reference Get(int i, int j);
00079     const_reference Get(int i, int j) const;
00080     reference operator[] (int i);
00081     const_reference operator[] (int i) const;
00082     Matrix_HermPacked<T, Prop, Storage, Allocator>&
00083     operator= (const Matrix_HermPacked<T, Prop, Storage, Allocator>& A);
00084     void Set(int i, int j, const T& val);
00085     void Copy(const Matrix_HermPacked<T, Prop, Storage, Allocator>& A);
00086 
00087     // Convenient functions.
00088     void Zero();
00089     void SetIdentity();
00090     void Fill();
00091     template <class T0>
00092     void Fill(const T0& x);
00093     template <class T0>
00094     Matrix_HermPacked<T, Prop, Storage, Allocator>& operator= (const T0& x);
00095     void FillRand();
00096     void Print() const;
00097     void Print(int a, int b, int m, int n) const;
00098     void Print(int l) const;
00099 
00100     // Input/output functions.
00101     void Write(string FileName) const;
00102     void Write(ostream& FileStream) const;
00103     void WriteText(string FileName) const;
00104     void WriteText(ostream& FileStream) const;
00105     void Read(string FileName);
00106     void Read(istream& FileStream);
00107     void ReadText(string FileName);
00108     void ReadText(istream& FileStream);
00109 
00110   };
00111 
00112 
00114   template <class T, class Prop, class Allocator>
00115   class Matrix<T, Prop, ColHermPacked, Allocator>:
00116     public Matrix_HermPacked<T, Prop, ColHermPacked, Allocator>
00117   {
00118     // typedef declaration.
00119   public:
00120     typedef typename Allocator::value_type value_type;
00121     typedef Prop property;
00122     typedef ColHermPacked storage;
00123     typedef Allocator allocator;
00124 
00125   public:
00126     Matrix();
00127     Matrix(int i, int j = 0);
00128 
00129     template <class T0>
00130     Matrix<T, Prop, ColHermPacked, Allocator>& operator= (const T0& x);
00131     Matrix<T, Prop, ColHermPacked, Allocator>& operator= (const Matrix<T, Prop,
00132                                                          ColHermPacked,
00133                                                          Allocator>& A);
00134     template<class T0>
00135     Matrix<T, Prop, ColHermPacked, Allocator>& operator*= (const T0& x);
00136 
00137     void Resize(int i, int j);
00138 
00139   };
00140 
00141 
00143   template <class T, class Prop, class Allocator>
00144   class Matrix<T, Prop, RowHermPacked, Allocator>:
00145     public Matrix_HermPacked<T, Prop, RowHermPacked, Allocator>
00146   {
00147     // typedef declaration.
00148   public:
00149     typedef typename Allocator::value_type value_type;
00150     typedef Prop property;
00151     typedef RowHermPacked storage;
00152     typedef Allocator allocator;
00153 
00154   public:
00155     Matrix();
00156     Matrix(int i, int j = 0);
00157 
00158     template <class T0>
00159     Matrix<T, Prop, RowHermPacked, Allocator>& operator= (const T0& x);
00160     Matrix<T, Prop, RowHermPacked, Allocator>& operator= (const Matrix<T, Prop,
00161                                                          RowHermPacked,
00162                                                          Allocator>& A);
00163     template<class T0>
00164     Matrix<T, Prop, RowHermPacked, Allocator>& operator*= (const T0& x);
00165 
00166     void Resize(int i, int j);
00167 
00168   };
00169 
00170 
00171 } // namespace Seldon.
00172 
00173 #define SELDON_FILE_MATRIX_HERMPACKED_HXX
00174 #endif