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

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

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

Public Member Functions

 MatMut (FromRawParts, isize nrows, isize ncols, isize nnz, I *col_ptrs, I *nnz_per_col, I *row_indices, T *values)
template<typename M>
 MatMut (FromEigen, M &&m)
auto values () const noexcept -> T const *
auto values_mut () const noexcept -> T *
auto is_compressed () const noexcept -> bool
auto as_const () const noexcept -> MatRef< T, I >
auto symbolic () const noexcept -> SymbolicMatRef< I >
auto symbolic_mut () const noexcept -> SymbolicMatRef< I >
auto to_eigen () const noexcept -> Eigen::Map< Eigen::SparseMatrix< T, Eigen::ColMajor, I > >
void _set_nnz (isize new_nnz) noexcept
Public Member Functions inherited from proxsuite::linalg::sparse::_detail::SymbolicMatMutInterface< MatMut< T, isize >, isize >
auto col_ptrs_mut () noexcept -> isize *
auto nnz_per_col_mut () noexcept -> isize *
auto row_indices_mut () noexcept -> isize *
Public Member Functions inherited from proxsuite::linalg::sparse::_detail::SymbolicMatRefInterface< MatMut< T, isize >, isize >
auto nrows () const noexcept -> isize
auto ncols () const noexcept -> isize
auto nnz () const noexcept -> isize
auto col_ptrs () const noexcept -> isize const *
auto nnz_per_col () const noexcept -> isize const *
auto is_compressed () const noexcept -> bool
auto row_indices () const noexcept -> isize 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< MatMut, I >
struct _detail::SymbolicMatMutInterface< MatMut, I >

Detailed Description

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

Definition at line 444 of file core.hpp.

Constructor & Destructor Documentation

◆ MatMut() [1/2]

template<typename T, typename I = isize>
proxsuite::linalg::sparse::MatMut< T, I >::MatMut(FromRawParts,
isizenrows,
isizencols,
isizennz,
I *col_ptrs,
I *nnz_per_col,
I *row_indices,
T *values )
inline

Definition at line 448 of file core.hpp.

◆ MatMut() [2/2]

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

Definition at line 463 of file core.hpp.

Member Function Documentation

◆ values()

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

Definition at line 477 of file core.hpp.

◆ values_mut()

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

Definition at line 478 of file core.hpp.

◆ is_compressed()

template<typename T, typename I = isize>
auto proxsuite::linalg::sparse::MatMut< T, I >::is_compressed()const -> bool
inlinenoexcept

Definition at line 479 of file core.hpp.

◆ as_const()

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

Definition at line 484 of file core.hpp.

◆ symbolic()

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

Definition at line 492 of file core.hpp.

◆ symbolic_mut()

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

Definition at line 499 of file core.hpp.

◆ to_eigen()

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

Definition at line 508 of file core.hpp.

◆ _set_nnz()

template<typename T, typename I = isize>
void proxsuite::linalg::sparse::MatMut< T, I >::_set_nnz(isizenew_nnz)
inlinenoexcept

Definition at line 513 of file core.hpp.

◆ _detail::SymbolicMatRefInterface< MatMut, I >

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

Definition at line 439 of file core.hpp.

◆ _detail::SymbolicMatMutInterface< MatMut, I >

template<typename T, typename I = isize>
friend struct _detail::SymbolicMatMutInterface< MatMut, I >
friend

Definition at line 439 of file core.hpp.

Member Data Documentation

◆ nrows

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

Definition at line 518 of file core.hpp.

◆ ncols

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

Definition at line 519 of file core.hpp.

◆ nnz

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

Definition at line 520 of file core.hpp.

◆ col

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

Definition at line 521 of file core.hpp.

◆ nnz_per_col

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

Definition at line 522 of file core.hpp.

◆ row

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

Definition at line 523 of file core.hpp.

◆ val

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

Definition at line 524 of file core.hpp.

The documentation for this struct was generated from the following file:
  • include/proxsuite/linalg/sparse/core.hpp