MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_PermutationSerial.hpp
Go to the documentation of this file.
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 SLAP_PERMUTATION_SERIAL_H
00043 #define SLAP_PERMUTATION_SERIAL_H
00044 
00045 #include "AbstractLinAlgPack_VectorSpaceSerial.hpp"
00046 #include "AbstractLinAlgPack_Permutation.hpp"
00047 
00048 namespace AbstractLinAlgPack {
00049 
00059 class PermutationSerial
00060   : public AbstractLinAlgPack::Permutation
00061 {
00062 public:
00063 
00066 
00068   typedef Teuchos::RCP<const IVector>  i_vector_ptr_t;
00069 
00071 
00074 
00077   PermutationSerial( size_type dim = 0 );
00078 
00081   PermutationSerial(
00082     const i_vector_ptr_t      &perm
00083     ,const i_vector_ptr_t     &inv_perm
00084     ,bool                     allocate_missing_perm = true
00085     ,bool                     check_inv_perm        = false
00086     );
00087   
00097   void initialize_identity( size_type dim );
00098 
00159   void initialize(
00160     const i_vector_ptr_t      &perm
00161     ,const i_vector_ptr_t     &inv_perm
00162     ,bool                     allocate_missing_perm = true
00163     ,bool                     check_inv_perm        = false
00164     );
00165 
00167 
00170   
00176   const i_vector_ptr_t& perm() const;
00182   const i_vector_ptr_t& inv_perm() const;
00183 
00185 
00188   
00190   const VectorSpace& space() const;
00192   size_type dim() const;
00194   bool is_identity() const;
00196   std::ostream& output(std::ostream& out) const;
00198   void permute( 
00199     BLAS_Cpp::Transp          P_trans
00200     ,const Vector       &x
00201     ,VectorMutable      *y
00202     ) const;
00204   void permute( 
00205     BLAS_Cpp::Transp          P_trans
00206     ,VectorMutable      *y
00207     ) const;
00208 
00210 
00211 private:
00212   
00213 #ifdef DOXYGEN_COMPILE
00214   VectorSpaceSerial     space;
00215   DenseLinAlgPack::IVector   *perm;
00216   DenseLinAlgPack::IVector   *inv_perm;
00217 #else
00218   VectorSpaceSerial     space_;
00219   i_vector_ptr_t        perm_;
00220   i_vector_ptr_t        inv_perm_;
00221 #endif
00222 
00223 }; // end class PermutationSerial
00224 
00225 // //////////////////////////////////////////////
00226 // Inline members
00227 
00228 inline
00229 const PermutationSerial::i_vector_ptr_t&
00230 PermutationSerial::perm() const
00231 {
00232   return perm_;
00233 }
00234 
00235 inline
00236 const PermutationSerial::i_vector_ptr_t&
00237 PermutationSerial::inv_perm() const
00238 {
00239   return inv_perm_;
00240 }
00241 
00242 } // end namespace AbstractLinAlgPack
00243 
00244 #endif // SLAP_PERMUTATION_SERIAL_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines