Teuchos - Trilinos Tools Package Version of the Day
Teuchos_MatrixMarket_Banner.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 
00042 #ifndef __Teuchos_MatrixMarket_Banner_hpp
00043 #define __Teuchos_MatrixMarket_Banner_hpp
00044 
00045 #include <complex>
00046 #include <ostream>
00047 #include <string>
00048 
00049 #include "Teuchos_ConfigDefs.hpp"
00050 
00051 namespace Teuchos {
00052   namespace MatrixMarket {
00053 
00067     class TEUCHOSNUMERICS_LIB_DLL_EXPORT Banner {
00068     public:
00077       Banner (const std::string& line, const bool tolerant=false);
00078 
00086       const std::string& objectType() const { return objectType_; }
00087 
00093       const std::string& matrixType() const { return matrixType_; }
00094 
00099       const std::string& dataType() const { return dataType_; }
00100 
00122       const std::string& symmType() const { return symmType_; }
00123 
00124     private:
00125       static std::string validateObjectType (const std::string& objectType, const bool tolerant=false);
00126       static std::string validateMatrixType (const std::string& matrixType, const bool tolerant=false);
00127       static std::string validateDataType (const std::string& dataType, const bool tolerant=false);
00128       static std::string validateSymmType (const std::string& symmType, const bool tolerant=false);
00129 
00131       void setDefaults (const int howMany);
00132 
00133       std::string objectType_, matrixType_, dataType_, symmType_;
00134     };
00135 
00151     TEUCHOSNUMERICS_LIB_DLL_EXPORT std::ostream& operator<< (std::ostream& out, const Banner& banner);
00152 
00153   } // namespace MatrixMarket
00154 } // namespace Teuchos
00155 
00156 #endif // __Teuchos_MatrixMarket_Banner_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines