trilinos/tpetra/Tpetra__leftAndOrRightScaleCrsMatrix__decl_8hpp_source.html

// @HEADER

// *****************************************************************************

//          Tpetra: Templated Linear Algebra Services Package

//

// Copyright 2008 NTESS and the Tpetra contributors.

// SPDX-License-Identifier: BSD-3-Clause

// *****************************************************************************

// @HEADER


#ifndef TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP

#define TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP


#include "TpetraCore_config.h"

#include "Kokkos_ArithTraits.hpp"

#include "Kokkos_Core.hpp"

#include "Tpetra_CrsMatrix_fwd.hpp"

#include "Tpetra_Vector_fwd.hpp"


namespace Tpetra {


enum EScaling {

  SCALING_MULTIPLY,

  SCALING_DIVIDE

};


template<class SC, class LO, class GO, class NT>

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);


template<class SC, class LO, class GO, class NT>

void

leftAndOrRightScaleCrsMatrix (Tpetra::CrsMatrix<SC, LO, GO, NT>& A,

                              const Tpetra::Vector<typename Kokkos::ArithTraits<SC>::mag_type,

                                LO, GO, NT>& rowScalingFactors,

                              const Tpetra::Vector<typename Kokkos::ArithTraits<SC>::mag_type,

                                LO, GO, NT>& colScalingFactors,

                              const bool leftScale,

                              const bool rightScale,

                              const bool assumeSymmetric,

                              const EScaling scaling);


} // namespace Tpetra


#endif // TPETRA_LEFTANDORRIGHTSCALECRSMATRIX_DECL_HPP

Tpetra_CrsMatrix_fwd.hpp
Forward declaration of Tpetra::CrsMatrix.

Tpetra_Vector_fwd.hpp
Forward declaration of Tpetra::Vector.

Tpetra::CrsMatrix
Sparse matrix that presents a row-oriented interface that lets users read or modify entries.
Definition Tpetra_CrsMatrix_decl.hpp:406

Tpetra::Vector
A distributed dense vector.
Definition Tpetra_Vector_decl.hpp:45

Tpetra
Namespace Tpetra contains the class and methods constituting the Tpetra library.

Tpetra::EScaling
EScaling
Whether "scaling" a matrix means multiplying or dividing its entries.
Definition Tpetra_leftAndOrRightScaleCrsMatrix_decl.hpp:28

Tpetra::leftAndOrRightScaleCrsMatrix
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.
Definition Tpetra_leftAndOrRightScaleCrsMatrix_def.hpp:31