SparseCSC< Conf, StorageIndex > Struct Template Reference

#include <alpaqa/problem/sparsity.hpp>

Detailed Description

template<Config Conf, class StorageIndex>
struct alpaqa::sparsity::SparseCSC< Conf, StorageIndex >

Sparse compressed-column structure (CCS or CSC).

Definition at line 28 of file sparsity.hpp.

Collaboration diagram for SparseCSC< Conf, StorageIndex >:

Public Types
enum	Order { Unsorted = 0 , SortedRows = 1 }
using	storage_index_t = StorageIndex
using	index_vector_t = Eigen::VectorX< storage_index_t >
using	index_vector_view_t = Eigen::Ref< const index_vector_t >
using	index_vector_map_t = Eigen::Map< const index_vector_t >

Public Member Functions
length_t	nnz () const
	Get the number of structurally nonzero elements.

Public Attributes
length_t	rows = 0
length_t	cols = 0
Symmetry	symmetry = Symmetry::Unsymmetric
index_vector_view_t	inner_idx = index_vector_map_t{nullptr, 0}
index_vector_view_t	outer_ptr = index_vector_map_t{nullptr, 0}
Order	order = Unsorted

Member Typedef Documentation

storage_index_t

template<Config Conf, class StorageIndex >

using storage_index_t = StorageIndex

Definition at line 30 of file sparsity.hpp.

index_vector_t

template<Config Conf, class StorageIndex >

using index_vector_t = Eigen::VectorX<storage_index_t>

Definition at line 31 of file sparsity.hpp.

index_vector_view_t

template<Config Conf, class StorageIndex >

using index_vector_view_t = Eigen::Ref<const index_vector_t>

Definition at line 32 of file sparsity.hpp.

index_vector_map_t

template<Config Conf, class StorageIndex >

using index_vector_map_t = Eigen::Map<const index_vector_t>

Definition at line 33 of file sparsity.hpp.

Member Enumeration Documentation

Order

template<Config Conf, class StorageIndex >

enum Order

Enumerator
Unsorted	The row indices are not sorted.
SortedRows	Within each column, all row indices are sorted in ascending order.

Definition at line 38 of file sparsity.hpp.

Member Function Documentation

nnz()

template<Config Conf, class StorageIndex >

length_t nnz ( ) const

inline

Get the number of structurally nonzero elements.

Definition at line 47 of file sparsity.hpp.

Member Data Documentation

rows

template<Config Conf, class StorageIndex >

length_t rows = 0

Definition at line 34 of file sparsity.hpp.

cols

template<Config Conf, class StorageIndex >

length_t cols = 0

Definition at line 34 of file sparsity.hpp.

symmetry

template<Config Conf, class StorageIndex >

Symmetry symmetry = Symmetry::Unsymmetric

Definition at line 35 of file sparsity.hpp.

inner_idx

template<Config Conf, class StorageIndex >

index_vector_view_t inner_idx = index_vector_map_t{nullptr, 0}

Definition at line 36 of file sparsity.hpp.

outer_ptr

template<Config Conf, class StorageIndex >

index_vector_view_t outer_ptr = index_vector_map_t{nullptr, 0}

Definition at line 37 of file sparsity.hpp.

order

template<Config Conf, class StorageIndex >

Order order = Unsorted

Definition at line 44 of file sparsity.hpp.

---

The documentation for this struct was generated from the following file:

• src/alpaqa/include/alpaqa/problem/sparsity.hpp