Blaze 3.9
Classes
Matrix.h File Reference

Header file for the Matrix base class. More...

#include <blaze/math/Aliases.h>
#include <blaze/math/constraints/Symmetric.h>
#include <blaze/math/Exception.h>
#include <blaze/math/expressions/Forward.h>
#include <blaze/math/typetraits/IsClearable.h>
#include <blaze/math/typetraits/IsIdentity.h>
#include <blaze/math/typetraits/IsResizable.h>
#include <blaze/math/typetraits/IsShrinkable.h>
#include <blaze/math/typetraits/IsSquare.h>
#include <blaze/math/typetraits/IsSymmetric.h>
#include <blaze/math/typetraits/IsZero.h>
#include <blaze/system/Inline.h>
#include <blaze/util/Assert.h>
#include <blaze/util/EnableIf.h>
#include <blaze/util/FunctionTrace.h>
#include <blaze/util/MaybeUnused.h>
#include <blaze/util/Types.h>
#include <blaze/util/typetraits/IsSame.h>

Go to the source code of this file.

Classes

class  blaze::Matrix< MT, SO >
 Base class for matrices. More...
 

Functions

Matrix global functions
template<typename MT , bool SO>
MT & blaze::crtp_cast (Matrix< MT, SO > &matrix)
 CRTP-based conversion operation for non-constant matrices. More...
 
template<typename MT , bool SO>
const MT & blaze::crtp_cast (const Matrix< MT, SO > &matrix)
 CRTP-based conversion operation for constant matrices. More...
 
template<typename MT , bool SO>
MT::Iterator blaze::begin (Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
MT::ConstIterator blaze::begin (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
MT::ConstIterator blaze::cbegin (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
MT::Iterator blaze::end (Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
MT::ConstIterator blaze::end (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
MT::ConstIterator blaze::cend (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
constexpr size_t blaze::rows (const Matrix< MT, SO > &matrix) noexcept
 Returns the current number of rows of the matrix. More...
 
template<typename MT , bool SO>
constexpr size_t blaze::columns (const Matrix< MT, SO > &matrix) noexcept
 Returns the current number of columns of the matrix. More...
 
template<typename MT , bool SO>
constexpr size_t blaze::size (const Matrix< MT, SO > &matrix) noexcept
 Returns the total number of elements of the matrix. More...
 
template<typename MT , bool SO>
size_t blaze::capacity (const Matrix< MT, SO > &matrix) noexcept
 Returns the maximum capacity of the matrix. More...
 
template<typename MT , bool SO>
size_t blaze::capacity (const Matrix< MT, SO > &matrix, size_t i) noexcept
 Returns the current capacity of the specified row/column. More...
 
template<typename MT , bool SO>
size_t blaze::nonZeros (const Matrix< MT, SO > &matrix)
 Returns the total number of non-zero elements in the matrix. More...
 
template<typename MT , bool SO>
size_t blaze::nonZeros (const Matrix< MT, SO > &matrix, size_t i)
 Returns the number of non-zero elements in the specified row/column. More...
 
template<typename MT , bool SO>
constexpr void blaze::reset (Matrix< MT, SO > &matrix)
 Resetting the given matrix. More...
 
template<typename MT , bool SO>
constexpr void blaze::reset (Matrix< MT, SO > &&matrix)
 Resetting the given temporary matrix. More...
 
template<typename MT , bool SO>
constexpr void blaze::reset (Matrix< MT, SO > &matrix, size_t i)
 Reset the specified row/column of the given matrix. More...
 
template<typename MT , bool SO>
constexpr void blaze::reset (Matrix< MT, SO > &&matrix, size_t i)
 Reset the specified row/column of the given temporary matrix. More...
 
template<typename MT , bool SO>
constexpr void blaze::clear (Matrix< MT, SO > &matrix)
 Clearing the given matrix. More...
 
template<typename MT , bool SO>
constexpr void blaze::clear (Matrix< MT, SO > &&matrix)
 Clearing the given temporary matrix. More...
 
template<typename MT , bool SO>
void blaze::resize (Matrix< MT, SO > &matrix, size_t rows, size_t columns, bool preserve=true)
 Changing the size of the matrix. More...
 
template<typename MT , bool SO>
void blaze::shrinkToFit (Matrix< MT, SO > &matrix)
 Requesting the removal of unused capacity. More...
 
template<typename MT , bool SO>
void blaze::transpose (Matrix< MT, SO > &matrix)
 In-place transpose of the given matrix. More...
 
template<typename MT , bool SO>
void blaze::ctranspose (Matrix< MT, SO > &matrix)
 In-place conjugate transpose of the given matrix. More...
 
template<typename MT , bool SO>
MT::ResultType blaze::evaluate (const Matrix< MT, SO > &matrix)
 Evaluates the given matrix expression. More...
 
template<bool B, typename MT , bool SO>
MT::ResultType blaze::evaluateIf (const Matrix< MT, SO > &matrix)
 Conditional evaluation of the given matrix expression. More...
 
template<typename MT , bool SO>
constexpr bool blaze::isEmpty (const Matrix< MT, SO > &matrix) noexcept
 Checks if the given matrix is empty. More...
 
template<typename MT , bool SO>
bool blaze::isSquare (const Matrix< MT, SO > &matrix) noexcept
 Checks if the given matrix is a square matrix. More...
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
bool blaze::isSame (const Matrix< MT1, SO1 > &a, const Matrix< MT2, SO2 > &b) noexcept
 Returns whether the two given matrices represent the same observable state. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT & blaze::crtp_cast (Matrix< MT, SO > &matrix)
 CRTP-based conversion operation for non-constant matrices. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE const MT & blaze::crtp_cast (const Matrix< MT, SO > &matrix)
 CRTP-based conversion operation for constant matrices. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::Iterator blaze::begin (Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::ConstIterator blaze::begin (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::ConstIterator blaze::cbegin (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator to the first element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::Iterator blaze::end (Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::ConstIterator blaze::end (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT::ConstIterator blaze::cend (const Matrix< MT, SO > &matrix, size_t i)
 Returns an iterator just past the last element of row/column i. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE constexpr size_t blaze::rows (const Matrix< MT, SO > &matrix) noexcept
 Returns the current number of rows of the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE constexpr size_t blaze::columns (const Matrix< MT, SO > &matrix) noexcept
 Returns the current number of columns of the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE constexpr size_t blaze::size (const Matrix< MT, SO > &matrix) noexcept
 Returns the total number of elements of the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE size_t blaze::capacity (const Matrix< MT, SO > &matrix) noexcept
 Returns the maximum capacity of the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE size_t blaze::capacity (const Matrix< MT, SO > &matrix, size_t i) noexcept
 Returns the current capacity of the specified row/column. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE size_t blaze::nonZeros (const Matrix< MT, SO > &matrix)
 Returns the total number of non-zero elements in the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE size_t blaze::nonZeros (const Matrix< MT, SO > &matrix, size_t i)
 Returns the number of non-zero elements in the specified row/column. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE void blaze::resize (Matrix< MT, SO > &matrix, size_t m, size_t n, bool preserve)
 Changing the size of the matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE void blaze::shrinkToFit (Matrix< MT, SO > &matrix)
 Requesting the removal of unused capacity. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE void blaze::transpose (Matrix< MT, SO > &matrix)
 In-place transpose of the given matrix. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE void blaze::ctranspose (Matrix< MT, SO > &matrix)
 In-place conjugate transpose of the given matrix. More...
 
template<bool B, typename MT , bool SO>
decltype(auto) blaze::evaluateIf (const Matrix< MT, SO > &matrix)
 Conditional evaluation of the given matrix expression. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE constexpr bool blaze::isEmpty (const Matrix< MT, SO > &matrix) noexcept
 Checks if the given matrix is empty. More...
 
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE bool blaze::isSquare (const Matrix< MT, SO > &matrix) noexcept
 Checks if the given matrix is a square matrix. More...
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
BLAZE_ALWAYS_INLINE bool blaze::isSame (const Matrix< MT1, SO1 > &a, const Matrix< MT2, SO2 > &b) noexcept
 Returns whether the two given matrices represent the same observable state. More...
 

Detailed Description

Header file for the Matrix base class.

Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved

This file is part of the Blaze library. You can redistribute it and/or modify it under the terms of the New (Revised) BSD License. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the names of the Blaze development group nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ crtp_cast() [1/4]

template<typename MT , bool SO>
const MT & blaze::crtp_cast ( const Matrix< MT, SO > &  matrix)

CRTP-based conversion operation for constant matrices.

Returns
Const reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.

◆ crtp_cast() [2/4]

template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE const MT & blaze::crtp_cast ( const Matrix< MT, SO > &  matrix)

CRTP-based conversion operation for constant matrices.

Returns
Const reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.

◆ crtp_cast() [3/4]

template<typename MT , bool SO>
MT & blaze::crtp_cast ( Matrix< MT, SO > &  matrix)

CRTP-based conversion operation for non-constant matrices.

Returns
Mutable reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.

◆ crtp_cast() [4/4]

template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE MT & blaze::crtp_cast ( Matrix< MT, SO > &  matrix)

CRTP-based conversion operation for non-constant matrices.

Returns
Mutable reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.