File view_matrix_csc_binary.hpp

Typedefs

using AllocatedBinaryCscView = BinaryCscViewAllocator<BinaryCscView>

Allocates the memory, a BinaryCscView provides access to

class BinaryCscView : public BinarySparseMatrix
#include <view_matrix_csc_binary.hpp>

A two-dimensional view that provides column-wise access to binary values stored in a matrix in the compressed sparse column (CSC) format.

Subclassed by BinaryCscViewAllocator< BinaryCscView >

Public Types

using const_column = const Vector<const uint32>

Provides read-only access to an individual column in the view.

using column = Vector<uint32>

Provides access to an individual column in the view and allows to modify it.

Public Functions

inline BinaryCscView(uint32 *indices, uint32 *indptr, uint32 numRows, uint32 numCols)
Parameters:

  • indices – A pointer to an array of type uint32, shape (numDenseElements), that stores the row indices of all dense elements explicitly stored in the matrix

  • indptr – A pointer to an array of type uint32, shape (numCols + 1), that stores the indices of the first element in indices that corresponds to a certain column. The index at the position must be equal to numDenseElements

  • numRows – The number of rows in the view

  • numCols – The number of columns in the view

inline BinaryCscView(const BinaryCscView &other)
Parameters:

other – A const reference to an object of type BinaryCscView that should be copied

inline BinaryCscView(BinaryCscView &&other)
Parameters:

other – A reference to an object of type BinaryCscView that should be moved

inline virtual ~BinaryCscView() override
inline const_column operator[](uint32 column) const

Creates and returns a view that provides read-only access to a specific column in the view.

Parameters:

column – The index of the column

Returns:

An object of type const_column that has been created

inline column operator[](uint32 column)

Creates and returns a view that provides access to a specific column in the view and allows to modify it.

Parameters:

column – The index of the column

Returns:

An object of type column that has been created

inline BinarySparseMatrix::index_const_iterator indices_cbegin(uint32 column) const

Returns an index_const_iterator to the beginning of the indices in a specific column of the matrix.

Parameters:

column – The index of the column

Returns:

An index_const_iterator to the beginning of the indices

inline BinarySparseMatrix::index_const_iterator indices_cend(uint32 column) const

Returns an index_const_iterator to the end of the indices in a specific column of the matrix.

Parameters:

column – The index of the column

Returns:

An index_const_iterator to the end of the indices

inline BinarySparseMatrix::index_iterator indices_begin(uint32 column)

Returns an index_iterator to the beginning of the indices in a specific column of the matrix.

Parameters:

column – The index of the column

Returns:

An index_iterator to the beginning of the indices

inline BinarySparseMatrix::index_iterator indices_end(uint32 column)

Returns an index_iterator to the end of the indices in a specific column of the matrix.

Parameters:

column – The index of the column

Returns:

An index_iterator to the end of the indices

inline uint32 getNumDenseElements() const

Returns the number of dense elements explicitly stored in the view.

Returns:

The number of dense elements explicitly stored in the view

template<typename Matrix>
class BinaryCscViewAllocator : public Matrix
#include <view_matrix_csc_binary.hpp>

Allocates the memory for a two-dimensional view that provides column-wise access to binary values stored in a matrix in the compressed sparse column (CSC) format.

Template Parameters:

Matrix – The type of the view

Public Functions

inline BinaryCscViewAllocator(uint32 numDenseElements, uint32 numRows, uint32 numCols)
Parameters:

  • numDenseElements – The number of dense elements explicitly stored in the view

  • numRows – The number of rows in the view

  • numCols – The number of columns in the view

inline BinaryCscViewAllocator(const BinaryCscViewAllocator<Matrix> &other)
Parameters:

other – A reference to an object of type BinaryCscViewAllocator that should be copied

inline BinaryCscViewAllocator(BinaryCscViewAllocator<Matrix> &&other)
Parameters:

other – A reference to an object of type BinaryCscViewAllocator that should be moved

inline virtual ~BinaryCscViewAllocator() override