RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_LapackWrappers.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
00005 //       Operations
00006 //                Copyright (2006) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 
00043 #ifndef RTOPPACK_LAPACK_WRAPPERS_HPP
00044 #define RTOPPACK_LAPACK_WRAPPERS_HPP
00045 
00046 
00047 #include "RTOpPack_Types.hpp"
00048 #include "Teuchos_LAPACK.hpp"
00049 #include "Teuchos_as.hpp"
00050 
00051 
00052 namespace RTOpPack {
00053 
00054 
00056 enum ETransp {
00057   NOTRANS, TRANS, CONJTRANS
00058 };
00059 const int NUM_ETRANS_ARGS = 3;
00060 
00062 extern const Teuchos::Tuple<char,NUM_ETRANS_ARGS> transpMap;
00063 
00064 
00075 template<class Scalar>
00076 void getrf(
00077   const SubMultiVectorView<Scalar> &A,
00078   const ArrayView<int> &ipiv,
00079   const Ptr<int> &rank
00080   );
00081 
00082 
00084 template<class Scalar>
00085 void getrs(
00086   const ConstSubMultiVectorView<Scalar> &A,
00087   const ArrayView<const int> &ipiv,
00088   const ETransp transp,
00089   const Ptr<const SubMultiVectorView<Scalar> > &BX
00090   );
00091 
00092 
00093 } // namespace RTOpPack
00094 
00095 
00096 //
00097 // Implementations
00098 //
00099 
00100 
00101 template<class Scalar>
00102 void RTOpPack::getrf(
00103   const SubMultiVectorView<Scalar> &A,
00104   const ArrayView<int> &ipiv,
00105   const Ptr<int> &rank
00106   )
00107 {
00108   using Teuchos::as;
00109   const int maxRank = TEUCHOS_MIN( A.subDim(), A.numSubCols() );
00110 #ifdef TEUCHOS_DEBUG
00111   TEUCHOS_TEST_FOR_EXCEPT( A.subDim() == 0  );
00112   TEUCHOS_TEST_FOR_EXCEPT( A.numSubCols() == 0  );
00113   TEUCHOS_TEST_FOR_EXCEPT( is_null(A.values()) );
00114   TEUCHOS_ASSERT_EQUALITY( as<int>(ipiv.size()), maxRank );
00115 #endif
00116 
00117   Teuchos::LAPACK<int, Scalar> lapack;
00118   int info = -1;
00119   lapack.GETRF( A.subDim(), A.numSubCols(), A.values().get(), A.leadingDim(),
00120     &ipiv[0], &info );
00121   *rank = maxRank;
00122   TEUCHOS_TEST_FOR_EXCEPTION(
00123     info < 0, std::invalid_argument
00124     ,"getrf(...): Error, Invalid argument "
00125     << -info << " sent to LAPACK function xGETRF(...)" );
00126   if (info > 0)
00127     *rank = info - 1;
00128 }
00129 
00130 
00131 template<class Scalar>
00132 void RTOpPack::getrs(
00133   const ConstSubMultiVectorView<Scalar> &A,
00134   const ArrayView<const int> &ipiv,
00135   const ETransp transp,
00136   const Ptr<const SubMultiVectorView<Scalar> > &BX
00137   )
00138 {
00139   using Teuchos::as;
00140 #ifdef TEUCHOS_DEBUG
00141   TEUCHOS_ASSERT( !is_null(BX) );
00142   TEUCHOS_ASSERT_EQUALITY( A.subDim(), BX->subDim() );
00143   TEUCHOS_ASSERT_EQUALITY( A.subDim(), A.numSubCols() );
00144   TEUCHOS_TEST_FOR_EXCEPT( A.subDim() == 0  );
00145   TEUCHOS_TEST_FOR_EXCEPT( A.numSubCols() == 0  );
00146   TEUCHOS_TEST_FOR_EXCEPT( is_null(A.values()) );
00147   TEUCHOS_ASSERT_EQUALITY( A.subDim(), ipiv.size() );
00148 #endif
00149   Teuchos::LAPACK<int, Scalar> lapack;
00150   int info = -1;
00151   lapack.GETRS(
00152     transpMap[transp],
00153     A.subDim(), BX->numSubCols(), A.values().get(), A.leadingDim(),
00154     &ipiv[0], BX->values().get(), BX->leadingDim(), &info
00155     );
00156   TEUCHOS_TEST_FOR_EXCEPTION(
00157     info < 0, std::invalid_argument
00158     ,"getrs(...): Error, Invalid argument "
00159     << -info << " sent to LAPACK function xGETRS(...)" );
00160   // If we get here B is the solution to the linear system.
00161 }
00162 
00163 
00164 #endif // RTOPPACK_LAPACK_WRAPPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines