MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_DMatrixAssign.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 // ***********************************************************************
00041 //
00042 // These are assignment functions that used to be in GenMatrixOp but because of
00043 // some circular dependency problems their declarations where moved into a seprate
00044 // file.
00045
00046 #ifndef GEN_MATRIX_ASSIGN_H
00047 #define GEN_MATRIX_ASSIGN_H
00048
00049 #include "DenseLinAlgPack_Types.hpp"
00050
00051 namespace DenseLinAlgPack {
00052
00053 // ///////////////////////////////////////////////////////////////////////////////////
00054 /* * @name {\bf DMatrix/DMatrixSlice Assignment Fucntions}.
00055   *
00056   * These are functions for assigning one matrix to another.  The rhs matrices
00057   * can be transposed (op(rhs) = rhs) or non-transposed (op(rhs) = trans(rhs).
00058   * The assignment operators for
00059   * DMatrix and DMatrixSlice use these functions to implement their
00060   * assignment operator functions.  The assignmet functions for triangular
00061   * matrices are ment to be called from the assignment operator functions
00062   * for wrapper classes for triangular (upper and lower) and sysmetric
00063   * (upper and lower storage).
00064   *
00065   * These assignment functions check for aliasing and assignment to self
00066   * and create any needed temporaries if needed.
00067   */
00068 // @{
00069
00071 void assign(DMatrix* gm_lhs, value_type alpha);
00072
00074 void assign(DMatrix* gm_lhs, const DMatrixSlice& gms_rhs, BLAS_Cpp::Transp trans_rhs);
00075
00077 void assign(DMatrixSlice* gms_lhs, value_type alpha);
00078
00080 void assign(DMatrixSlice* gms_lhs, const DMatrixSlice& gms_rhs, BLAS_Cpp::Transp trans_rhs);
00081
00083 void assign(DMatrixSliceTriEle* tri_gms_lhs, value_type alpha);
00084
00086 void assign(DMatrixSliceTriEle* tri_ele_gms_lhs, const DMatrixSliceTriEle& tri_ele_gms_rhs);
00087
00088 //    end Assignment Fucntions
00089 // @}
00090
00091 } // end namespace DenseLinAlgPack
00092
00093 #endif  // GEN_MATRIX_ASSIGN_H