AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_Permutation.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 ALAP_PERMUTATION_H
00043 #define ALAP_PERMUTATION_H
00044 
00045 #include "AbstractLinAlgPack_Types.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00056 class Permutation {
00057 public:
00058 
00060   virtual ~Permutation() {}
00061 
00064   
00067   virtual const VectorSpace& space() const = 0;
00068   
00070 
00073 
00075   virtual size_type dim() const = 0;
00076 
00078   virtual bool is_identity() const = 0;
00079 
00081   virtual std::ostream& output(std::ostream& out) const = 0;
00082 
00084 
00087 
00103   virtual void permute( 
00104     BLAS_Cpp::Transp    P_trans
00105     ,const Vector       &x
00106     ,VectorMutable      *y
00107     ) const = 0;
00108 
00121   virtual void permute( 
00122     BLAS_Cpp::Transp    P_trans
00123     ,VectorMutable      *y
00124     ) const = 0;
00125 
00127 
00128 }; // end class Permutation
00129 
00130 } // end namespace AbstractLinAlgPack
00131 
00132 #endif // ALAP_PERMUTATION_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends