ADOLC::Sparse::CoordinateFormatTripled Class Reference

One nonzero entry of a sparse matrix in coordinate format. More...

#include <sparsematrix.h>

Classes
struct	Coordinates
	Zero-based row and column coordinates of one sparse entry. More...

Public Types
using	coordinate_type = unsigned int

Public Member Functions
	CoordinateFormatTripled ()=default
	~CoordinateFormatTripled ()=default
	CoordinateFormatTripled (const CoordinateFormatTripled &)=default
CoordinateFormatTripled &	operator= (const CoordinateFormatTripled &)=default
	CoordinateFormatTripled (CoordinateFormatTripled &&) noexcept=default
CoordinateFormatTripled &	operator= (CoordinateFormatTripled &&) noexcept=default
constexpr	CoordinateFormatTripled (Coordinates coords, double value)
	Construct one coordinate-format triplet.
constexpr	CoordinateFormatTripled (coordinate_type rowIndex, coordinate_type colIndex, double value)
	Construct one coordinate-format triplet.
coordinate_type	rowIndex () const noexcept
	Get the row index.
coordinate_type	colIndex () const noexcept
	Get the column index.
double	value () const noexcept
	Get the numerical value.

Detailed Description

One nonzero entry of a sparse matrix in coordinate format.

The format stores the recovered nonzeros as triplets. This keeps row, column, and value ownership tied together and makes the representation easier to move and copy as one object.

Member Typedef Documentation

coordinate_type

using ADOLC::Sparse::CoordinateFormatTripled::coordinate_type = unsigned int

Constructor & Destructor Documentation

CoordinateFormatTripled() [1/5]

ADOLC::Sparse::CoordinateFormatTripled::CoordinateFormatTripled ( )

default

~CoordinateFormatTripled()

ADOLC::Sparse::CoordinateFormatTripled::~CoordinateFormatTripled ( )

default

CoordinateFormatTripled() [2/5]

ADOLC::Sparse::CoordinateFormatTripled::CoordinateFormatTripled ( const CoordinateFormatTripled &  )

default

CoordinateFormatTripled() [3/5]

ADOLC::Sparse::CoordinateFormatTripled::CoordinateFormatTripled ( CoordinateFormatTripled &&  )

defaultnoexcept

CoordinateFormatTripled() [4/5]

constexpr ADOLC::Sparse::CoordinateFormatTripled::CoordinateFormatTripled ( Coordinates  coords, double  value  )

inlineconstexpr

Construct one coordinate-format triplet.

Parameters

coords	Zero-based row index and column index
value	Numerical value stored at (rowIdx, colIdx).

CoordinateFormatTripled() [5/5]

constexpr ADOLC::Sparse::CoordinateFormatTripled::CoordinateFormatTripled ( coordinate_type  rowIndex, coordinate_type  colIndex, double  value  )

inlineconstexpr

Construct one coordinate-format triplet.

Parameters

rowIndex	Zero-based row index
colIndex	Zero-based column index
value	Numerical value stored at (rowIndex, colIndex).

Member Function Documentation

colIndex()

coordinate_type ADOLC::Sparse::CoordinateFormatTripled::colIndex ( ) const

inlinenoexcept

Get the column index.

operator=() [1/2]

CoordinateFormatTripled & ADOLC::Sparse::CoordinateFormatTripled::operator= ( const CoordinateFormatTripled &  )

default

operator=() [2/2]

CoordinateFormatTripled & ADOLC::Sparse::CoordinateFormatTripled::operator= ( CoordinateFormatTripled &&  )

defaultnoexcept

rowIndex()

coordinate_type ADOLC::Sparse::CoordinateFormatTripled::rowIndex ( ) const

inlinenoexcept

Get the row index.

value()

double ADOLC::Sparse::CoordinateFormatTripled::value ( ) const

inlinenoexcept

Get the numerical value.

---

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

• sparsematrix.h