MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_PermVecMat.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 // Utilities for pivoting VectorSlices and GenMatrixSlices.
00043 
00044 #ifndef PIVOTVECMAT_H
00045 #define PIVOTVECMAT_H
00046 
00047 #include <stdexcept>
00048 
00049 #include "DenseLinAlgPack_Types.hpp"
00050 
00051 /* * @name {\bf DVector / Matrix Permutations}.
00052   *
00053   * These are functions for pivoting the elements of a vector and the 
00054   * rows and/or columns of a rectandular matrix.
00055   *
00056   * For DVector and DVectorSlice pivot funcitions the #perm# argument
00057   * gives the mapping from the new sequence to the old sequence.
00058   * The statement #i_old = perm(i_new)# gives the index in the
00059   * old vector.  After the permutation is performed the postcondition:
00060   \verbatim
00061 
00062     perm_vs(i) == vs(perm(i)), for i = 1,2,...,vs.size()
00063 
00064   \endverbatim
00065   * is true.
00066   *
00067   * For the DMatrix permutation functions the #row_perm# argument
00068   * gives the row permutations and the #col_perm# argument gives the column
00069   * permutations respectively.
00070   *
00071   * In each of these functions the permuted object can be the same
00072   * as the unpermuted object.
00073   */
00074 
00075 // @{
00076 
00077 // @Include: DenseLinAlgPack_IVector.hpp
00078 
00079 // /////////////////////////////////////////////////////////////////////////////////////////
00080 // Public Permutation functions
00081 
00082 namespace DenseLinAlgPack {
00083 
00085 /* * Initialize a permutation to the identiy permutation.
00086   *
00087   * Preconditions: <ul>
00088   * <li> #perm.size() > 0# (throw std::length_error)
00089   * </ul>
00090   *
00091   * Postconditions: <ul>
00092   * <li> #perm(i) = i#, for i = 1, 2, ... m #perm.size()#
00093   * </ul>
00094   */
00095 void identity_perm(IVector* perm);
00096 
00098 /* * Find the inverse permutation (inv_perm) given a permutation vector (perm).
00099   *
00100   * Postconditions: <ul>
00101   * <li> #inv_perm.size() == perm.size()#
00102   * </ul>
00103   */
00104 void inv_perm(const IVector& perm, IVector* inv_perm);
00105 
00107 void perm_ele(const IVector& perm, DVectorSlice* vs);
00108 
00110 void perm_ele(const DVectorSlice& x, const IVector& perm, DVectorSlice* y);
00111 
00113 void inv_perm_ele(const DVectorSlice& y, const IVector& perm, DVectorSlice* x);
00114 
00116 void perm_rows(const IVector& row_perm, DMatrixSlice* gms);
00117 
00119 void perm_cols(const IVector& col_perm, DMatrixSlice* gms);
00120 
00122 void perm_rows_cols(const IVector& row_perm, const IVector& col_perm, DMatrixSlice* gms);
00123 
00124 #ifdef TEUCHOS_DEBUG
00125 extern bool PermVecMat_print;
00126 #endif
00127 
00128 } // end namespace DenseLinAlgPack
00129 
00130 // @}
00131 
00132 #endif // PIVOTVECMAT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines