lds::UniformMatrixList

lds::UniformMatrixList #

More…

Inherits from std::vector< Matrix >

Public Functions #

Name
UniformMatrixList() =default
Constructs a new UniformMatrixList.
UniformMatrixList(const std::vector< Matrix > & mats, std::array< size_t, 2 > dim ={0, 0})
Constructs a new UniformMatrixList by copying existing vector of Matrix if dimensions consistent.
UniformMatrixList(std::vector< Matrix > && mats, std::array< size_t, 2 > dim ={0, 0})
Constructs a new UniformMatrixList by moving existing vector of Matrix if dimensions consistent.
UniformMatrixList(std::initializer_list< Matrix > mats, std::array< size_t, 2 > dim ={0, 0})
Constructs a new UniformMatrixList from initializer_list of Matrix if dimensions consistent.
UniformMatrixList(const UniformMatrixList< D > & that)
Constructs a new UniformMatrixList (copy).
UniformMatrixList(UniformMatrixList< D > && that)
Constructs a new UniformMatrixList (move).
~UniformMatrixList() =default
Destroys the object.
const std::array< size_t, 2 > & dim(size_t n =0) const
gets dimensions of uniformly sized matrices
size_t size()
size of container
const Matrix & at(size_t n)
gets reference to n^th element
void Swap(Matrix & that, size_t n)
swaps input matrix with n^th matrix of list
UniformMatrixList< D > & operator=(const UniformMatrixList< D > & that)
assigns the contents (copy)
UniformMatrixList< D > & operator=(UniformMatrixList< D > && that)
assigns the contents (move)

Detailed Description # 

template <MatrixListFreeDim D =kMatFreeDimNone>
class lds::UniformMatrixList;

Public Function Details #

UniformMatrixList # 

UniformMatrixList() =default

UniformMatrixList # 

explicit UniformMatrixList(
    const std::vector< Matrix > & mats,
    std::array< size_t, 2 > dim ={0, 0}
)

Parameters:

  • mats input matrices
  • dim dimensions

UniformMatrixList # 

explicit UniformMatrixList(
    std::vector< Matrix > && mats,
    std::array< size_t, 2 > dim ={0, 0}
)

Parameters:

  • mats input matrices
  • dim dimensions

UniformMatrixList # 

UniformMatrixList(
    std::initializer_list< Matrix > mats,
    std::array< size_t, 2 > dim ={0, 0}
)

Parameters:

  • mats input matrices
  • dim dimensions

UniformMatrixList # 

UniformMatrixList(
    const UniformMatrixList< D > & that
)

Parameters:

UniformMatrixList # 

UniformMatrixList(
    UniformMatrixList< D > && that
)

Parameters:

~UniformMatrixList # 

~UniformMatrixList() =default

dim # 

inline const std::array< size_t, 2 > & dim(
    size_t n =0
) const

Parameters:

  • n [optional] index in list of matrices

Return: dimensions

size # 

inline size_t size()

at # 

inline const Matrix & at(
    size_t n
)

Swap # 

inline void Swap(
    Matrix & that,
    size_t n
)

Parameters:

  • that input matrix
  • n index where the matrix is moved

operator= # 

inline UniformMatrixList< D > & operator=(
    const UniformMatrixList< D > & that
)

Parameters:

Return: reference to object

operator= # 

inline UniformMatrixList< D > & operator=(
    UniformMatrixList< D > && that
)

Parameters:

Return: reference to object

Updated on 19 May 2022 at 17:16:04 Eastern Daylight Time