Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_MatrixMarket_assignScalar.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef __Teuchos_MatrixMarket_assignScalar_hpp
43 #define __Teuchos_MatrixMarket_assignScalar_hpp
44 
45 #include <Teuchos_as.hpp>
46 #include <Teuchos_ScalarTraits.hpp>
47 #include <string>
48 
49 
50 namespace Teuchos {
51  namespace MatrixMarket {
52  namespace details {
53 
59  template<class Scalar, bool isComplex=Teuchos::ScalarTraits<Scalar>::isComplex>
61  public:
62  static void
63  assign (Scalar& val,
66  };
67 
68  // Partial specialization for real Scalar types.
69  template<class RealType>
70  class ScalarAssigner<RealType, false> {
71  public:
72  static void
73  assign (RealType& val,
76  {
77  // imag had better be zero. We're ignoring it regardless.
78  (void) imag;
79  val = real;
80  }
81  };
82 
83 #ifdef HAVE_TEUCHOS_COMPLEX
84  // Partial specialization for complex Scalar types.
85  // MagType is the template parameter for std::complex.
86  template<class MagType>
87  class ScalarAssigner<std::complex<MagType>, true> {
88  public:
89  static void
90  assign (std::complex<MagType>& val,
91  const typename Teuchos::ScalarTraits<std::complex<MagType> >::magnitudeType& real,
92  const typename Teuchos::ScalarTraits<std::complex<MagType> >::magnitudeType& imag)
93  {
94  val = std::complex<MagType> (real, imag);
95  }
96  };
97 #endif // HAVE_TEUCHOS_COMPLEX
98 
105  template<class Scalar>
106  void
107  assignScalar (Scalar& val,
110  {
111  ScalarAssigner<Scalar>::assign (val, real, imag);
112  }
113 
114  } // namespace details
115  } // namespace MatrixMarket
116 } // namespace Teuchos
117 
118 #endif // __Teuchos_MatrixMarket_assignScalar_hpp
T magnitudeType
Mandatory typedef for result of magnitude.
This structure defines some basic traits for a scalar field type.
Defines basic traits for the scalar field type.
Definition of Teuchos::as, for conversions between types.