Matrix view

matrix_descr

Definition

namespace oneapi::math::sparse {

    enum class matrix_descr {
        general,
        symmetric,
        hermitian,
        triangular,
        diagonal,
    };

}

Description

The matrix descriptor describes how an operation should interpret the data.

Value	Description
general	General case, use complete data.
symmetric	View as symmetric, use given triangular part.
hermitian	View as hermitian, use given triangular part.
triangular	View as triangular, use given triangular part.
diagonal	View as diagonal, use only main diagonal values.

matrix_view

Definition

namespace oneapi::math::sparse {

    struct matrix_view {
        matrix_descr type_view = matrix_descr::general;
        uplo uplo_view = uplo::lower;
        diag diag_view = diag::nonunit;

        matrix_view() = default;

        matrix_view(matrix_descr type_view);
    };

}

Description

The matrix view holds information to specify which part of the matrix should be read without changing the matrix’s data.

See matrix_descr, uplo and diag for a description of the members.

Each operation documents which combination of type_view, uplo_view and diag_view are valid.

Syntax

namespace oneapi::math::sparse {

    matrix_view::matrix_view () = default;

}

Default Constructor

Initializes the matrix_view with the default values as shown in the class definition.

Syntax

namespace oneapi::math::sparse {

    matrix_view::matrix_view(matrix_descr type_view);

}

Constructor from a matrix_descr

Initializes the matrix_view with the provided matrix_descr. By default the other members are initialized to the same value as the default constructor.

Parent topic: Sparse BLAS