Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_leftAndOrRightScaleCrsMatrix_decl.hpp
Go to the documentation of this file.
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 TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP
43#define TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP
44
47
48#include "TpetraCore_config.h"
49#include "Kokkos_ArithTraits.hpp"
50#include "Kokkos_Core.hpp"
52#include "Tpetra_Vector_fwd.hpp"
53
54namespace Tpetra {
55
61 SCALING_MULTIPLY,
62 SCALING_DIVIDE
63};
64
91template<class SC, class LO, class GO, class NT>
92void
94 const Kokkos::View<
95 const typename Kokkos::ArithTraits<SC>::mag_type*,
96 typename NT::device_type>& rowScalingFactors,
97 const Kokkos::View<
98 const typename Kokkos::ArithTraits<SC>::mag_type*,
99 typename NT::device_type>& colScalingFactors,
100 const bool leftScale,
101 const bool rightScale,
102 const bool assumeSymmetric,
103 const EScaling scaling);
104
132template<class SC, class LO, class GO, class NT>
133void
135 const Tpetra::Vector<typename Kokkos::ArithTraits<SC>::mag_type,
136 LO, GO, NT>& rowScalingFactors,
137 const Tpetra::Vector<typename Kokkos::ArithTraits<SC>::mag_type,
138 LO, GO, NT>& colScalingFactors,
139 const bool leftScale,
140 const bool rightScale,
141 const bool assumeSymmetric,
142 const EScaling scaling);
143
144} // namespace Tpetra
145
146#endif // TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP
Forward declaration of Tpetra::CrsMatrix.
Forward declaration of Tpetra::Vector.
Struct that holds views of the contents of a CrsMatrix.
A distributed dense vector.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
EScaling
Whether "scaling" a matrix means multiplying or dividing its entries.
void leftAndOrRightScaleCrsMatrix(Tpetra::CrsMatrix< SC, LO, GO, NT > &A, const Kokkos::View< const typename Kokkos::ArithTraits< SC >::mag_type *, typename NT::device_type > &rowScalingFactors, const Kokkos::View< const typename Kokkos::ArithTraits< SC >::mag_type *, typename NT::device_type > &colScalingFactors, const bool leftScale, const bool rightScale, const bool assumeSymmetric, const EScaling scaling)
Left-scale and/or right-scale (in that order) the entries of the input Tpetra::CrsMatrix A.