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_Permutation.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 ALAP_PERMUTATION_H
43 #define ALAP_PERMUTATION_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
56 class Permutation {
57 public:
58 
60  virtual ~Permutation() {}
61 
64 
67  virtual const VectorSpace& space() const = 0;
68 
70 
73 
75  virtual size_type dim() const = 0;
76 
78  virtual bool is_identity() const = 0;
79 
81  virtual std::ostream& output(std::ostream& out) const = 0;
82 
84 
87 
103  virtual void permute(
104  BLAS_Cpp::Transp P_trans
105  ,const Vector &x
106  ,VectorMutable *y
107  ) const = 0;
108 
121  virtual void permute(
122  BLAS_Cpp::Transp P_trans
123  ,VectorMutable *y
124  ) const = 0;
125 
127 
128 }; // end class Permutation
129 
130 } // end namespace AbstractLinAlgPack
131 
132 #endif // ALAP_PERMUTATION_H
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
virtual const VectorSpace & space() const =0
Return a reference to a vector space object that this permutation is compatible with.
virtual size_type dim() const =0
Return the dimension of the permutation.
virtual void permute(BLAS_Cpp::Transp P_trans, const Vector &x, VectorMutable *y) const =0
Permute a vector op(P)*x -> y
Abstract interface for objects that represent a space for mutable coordinate vectors.
virtual std::ostream & output(std::ostream &out) const =0
Prints debug type of information.
virtual bool is_identity() const =0
Returns true if this is the identity permutation I.
Abstract interface to permutation matrices.
Abstract interface for mutable coordinate vectors {abstract}.
Transp