DenseLinAlgPack: Concreate C++ Classes for Dense Blas-Compatible Linear Algebra Version of the Day
DenseLinAlgPack_IVector.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef IVECTOR_H
00043 #define IVECTOR_H
00044 
00045 #include <assert.h>
00046 
00047 #include <valarray>
00048 
00049 #include "DenseLinAlgPack_Types.hpp"
00050 #include "Teuchos_Assert.hpp"
00051 
00052 namespace DenseLinAlgPack {
00054 /* * Fortran compatable integer vector for holding the  pivot information for
00055  * the elements of a vector, or the rows or columns of a matrix.
00056  */
00057 class IVector : public std::valarray<DenseLinAlgPack::size_type> {
00058 public:
00059 
00060   // STL typedefs
00061   typedef DenseLinAlgPack::index_type   value_type;
00062   typedef DenseLinAlgPack::size_type    size_type;
00063   typedef value_type&         reference;
00064   typedef const value_type&     const_reference;
00065   typedef value_type*         iterator;
00066   typedef const value_type*     const_iterator;
00067   typedef std::valarray<size_type>  valarray;
00068 
00069   // constructors
00070 
00072   IVector();
00074   IVector(size_type n);
00076   IVector(const value_type& val, size_type n);
00078   IVector(const value_type* p, size_type n);
00079 
00081   IVector& operator=(const IVector&);
00082 
00084   reference operator()(size_type i);
00086   const_reference operator()(size_type i) const;
00087 
00089   iterator begin();
00091   const_iterator begin() const;
00093   iterator end();
00095   const_iterator end() const;
00096 
00097 }; // end class IVector
00098 
00099 // Inline definitions
00100 
00101 inline IVector::IVector() : std::valarray<size_type>()
00102 {}
00103 
00104 inline IVector::IVector(size_type n) : std::valarray<size_type>(n)
00105 {}
00106 
00107 inline IVector::IVector(const value_type& val, size_type n) : std::valarray<size_type>(val,n)
00108 {}
00109 
00110 inline IVector::IVector(const value_type* p, size_type n) : std::valarray<size_type>(p,n)
00111 {}
00112 
00113 inline IVector& IVector::operator=(const IVector& iv)
00114 {
00115   this->resize(iv.size());
00116   std::valarray<DenseLinAlgPack::size_type>::operator=(iv);
00117   return *this;
00118 }
00119 
00120 inline IVector::reference IVector::operator()(size_type i)
00121 {
00122 #ifdef TEUCHOS_DEBUG
00123   TEUCHOS_TEST_FOR_EXCEPT( !(  1 <= i && i <= static_cast<size_type>(size())  ) );
00124 #endif
00125   return operator[](i-1);
00126 }
00127 
00128 inline IVector::const_reference IVector::operator()(size_type i) const
00129 {
00130 #ifdef TEUCHOS_DEBUG
00131   TEUCHOS_TEST_FOR_EXCEPT( !(  1 <= i && i <= static_cast<size_type>(size())  ) );
00132 #endif
00133   return const_cast<IVector*>(this)->operator[](i-1);
00134 }
00135 
00136 inline IVector::iterator IVector::begin()
00137 { return &operator[](0); }
00138 
00139 inline IVector::const_iterator IVector::begin() const
00140 { return &(const_cast<IVector*>(this)->operator[](0)); }
00141 
00142 inline IVector::iterator IVector::end()
00143 { return begin() + size(); }
00144 
00145 inline IVector::const_iterator IVector::end() const
00146 { return begin() + size(); }
00147 
00148 } // end namespace DenseLinAlgPack
00149 
00150 #endif // IVECTOR_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends