proxsuite 0.6.7
The Advanced Proximal Optimization Toolbox
Loading...
Searching...
No Matches
proxsuite::linalg::sparse::MatRef< T, I > Struct Template Reference

#include <proxsuite/linalg/sparse/core.hpp>

Inheritance diagram for proxsuite::linalg::sparse::MatRef< T, I >:
[legend]
Collaboration diagram for proxsuite::linalg::sparse::MatRef< T, I >:
[legend]

Public Member Functions

 MatRef (FromRawParts, isize nrows, isize ncols, isize nnz, I const *col_ptrs, I const *nnz_per_col, I const *row_indices, T const *values)
 
template<typename M >
 MatRef (FromEigen, M const &m)
 
auto values () const noexcept -> T const *
 
auto symbolic () const noexcept -> SymbolicMatRef< I >
 
auto to_eigen () const noexcept -> Eigen::Map< Eigen::SparseMatrix< T, Eigen::ColMajor, I > const >
 
- Public Member Functions inherited from proxsuite::linalg::sparse::_detail::SymbolicMatRefInterface< D, I >
auto nrows () const noexcept -> isize
 
auto ncols () const noexcept -> isize
 
auto nnz () const noexcept -> isize
 
auto col_ptrs () const noexcept -> I const *
 
auto nnz_per_col () const noexcept -> I const *
 
auto is_compressed () const noexcept -> bool
 
auto row_indices () const noexcept -> I const *
 
auto col_start (usize j) const noexcept -> usize
 
auto col_start_unchecked (Unsafe, usize j) const noexcept -> usize
 
auto col_end (usize j) const noexcept -> usize
 
auto col_end_unchecked (Unsafe, usize j) const noexcept -> usize
 

Friends

struct _detail::SymbolicMatRefInterface< MatRef, I >
 

Detailed Description

template<typename T, typename I = isize>
struct proxsuite::linalg::sparse::MatRef< T, I >

Definition at line 383 of file core.hpp.

Constructor & Destructor Documentation

◆ MatRef() [1/2]

template<typename T , typename I = isize>
proxsuite::linalg::sparse::MatRef< T, I >::MatRef ( FromRawParts ,
isize nrows,
isize ncols,
isize nnz,
I const * col_ptrs,
I const * nnz_per_col,
I const * row_indices,
T const * values )
inline

Definition at line 386 of file core.hpp.

◆ MatRef() [2/2]

template<typename T , typename I = isize>
template<typename M >
proxsuite::linalg::sparse::MatRef< T, I >::MatRef ( FromEigen ,
M const & m )
inline

Definition at line 401 of file core.hpp.

Member Function Documentation

◆ values()

template<typename T , typename I = isize>
auto proxsuite::linalg::sparse::MatRef< T, I >::values ( ) const -> T const*
inlinenoexcept

Definition at line 415 of file core.hpp.

◆ symbolic()

template<typename T , typename I = isize>
auto proxsuite::linalg::sparse::MatRef< T, I >::symbolic ( ) const -> SymbolicMatRef<I>
inlinenoexcept

Definition at line 416 of file core.hpp.

◆ to_eigen()

template<typename T , typename I = isize>
auto proxsuite::linalg::sparse::MatRef< T, I >::to_eigen ( ) const -> Eigen::Map<Eigen::SparseMatrix<T, Eigen::ColMajor, I> const>
inlinenoexcept

Definition at line 424 of file core.hpp.

Friends And Related Symbol Documentation

◆ _detail::SymbolicMatRefInterface< MatRef, I >

template<typename T , typename I = isize>
friend struct _detail::SymbolicMatRefInterface< MatRef, I >
friend

Definition at line 378 of file core.hpp.

Member Data Documentation

◆ nrows

template<typename T , typename I = isize>
isize proxsuite::linalg::sparse::MatRef< T, I >::nrows

Definition at line 433 of file core.hpp.

◆ ncols

template<typename T , typename I = isize>
isize proxsuite::linalg::sparse::MatRef< T, I >::ncols

Definition at line 434 of file core.hpp.

◆ nnz

template<typename T , typename I = isize>
isize proxsuite::linalg::sparse::MatRef< T, I >::nnz

Definition at line 435 of file core.hpp.

◆ col

template<typename T , typename I = isize>
I const* proxsuite::linalg::sparse::MatRef< T, I >::col

Definition at line 436 of file core.hpp.

◆ nnz_per_col

template<typename T , typename I = isize>
I const* proxsuite::linalg::sparse::MatRef< T, I >::nnz_per_col

Definition at line 437 of file core.hpp.

◆ row

template<typename T , typename I = isize>
I const* proxsuite::linalg::sparse::MatRef< T, I >::row

Definition at line 438 of file core.hpp.

◆ val

template<typename T , typename I = isize>
T const* proxsuite::linalg::sparse::MatRef< T, I >::val

Definition at line 439 of file core.hpp.


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