AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_PermutationSerial.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef SLAP_PERMUTATION_SERIAL_H
43 #define SLAP_PERMUTATION_SERIAL_H
44 
45 #include "AbstractLinAlgPack_VectorSpaceSerial.hpp"
46 #include "AbstractLinAlgPack_Permutation.hpp"
47 
48 namespace AbstractLinAlgPack {
49 
59 class PermutationSerial
61 {
62 public:
63 
66 
68  typedef Teuchos::RCP<const IVector> i_vector_ptr_t;
69 
71 
74 
77  PermutationSerial( size_type dim = 0 );
78 
81  PermutationSerial(
82  const i_vector_ptr_t &perm
83  ,const i_vector_ptr_t &inv_perm
84  ,bool allocate_missing_perm = true
85  ,bool check_inv_perm = false
86  );
87 
97  void initialize_identity( size_type dim );
98 
159  void initialize(
160  const i_vector_ptr_t &perm
161  ,const i_vector_ptr_t &inv_perm
162  ,bool allocate_missing_perm = true
163  ,bool check_inv_perm = false
164  );
165 
167 
170 
176  const i_vector_ptr_t& perm() const;
182  const i_vector_ptr_t& inv_perm() const;
183 
185 
188 
190  const VectorSpace& space() const;
192  size_type dim() const;
194  bool is_identity() const;
196  std::ostream& output(std::ostream& out) const;
198  void permute(
199  BLAS_Cpp::Transp P_trans
200  ,const Vector &x
201  ,VectorMutable *y
202  ) const;
204  void permute(
205  BLAS_Cpp::Transp P_trans
206  ,VectorMutable *y
207  ) const;
208 
210 
211 private:
212 
213 #ifdef DOXYGEN_COMPILE
214  VectorSpaceSerial space;
216  DenseLinAlgPack::IVector *inv_perm;
217 #else
218  VectorSpaceSerial space_;
219  i_vector_ptr_t perm_;
220  i_vector_ptr_t inv_perm_;
221 #endif
222 
223 }; // end class PermutationSerial
224 
225 // //////////////////////////////////////////////
226 // Inline members
227 
228 inline
229 const PermutationSerial::i_vector_ptr_t&
230 PermutationSerial::perm() const
231 {
232  return perm_;
233 }
234 
235 inline
236 const PermutationSerial::i_vector_ptr_t&
237 PermutationSerial::inv_perm() const
238 {
239  return inv_perm_;
240 }
241 
242 } // end namespace AbstractLinAlgPack
243 
244 #endif // SLAP_PERMUTATION_SERIAL_H
size_t size_type
Abstract interface to permutation matrices.
Transp