slp::Spy Class Reference

Writes the sparsity pattern of a sparse matrix to a file. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/util/spy.hpp>

Public Member Functions
	Spy (std::string_view filename, std::string_view title, std::string_view row_label, std::string_view col_label, int rows, int cols)
	Constructs a Spy instance.
void	add (const Eigen::SparseMatrix< double > &mat)
	Adds a matrix to the file.

Detailed Description

Writes the sparsity pattern of a sparse matrix to a file.

Each file represents the sparsity pattern of one matrix over time. spy.py can display it as an animation.

The file starts with the following header:

1. Plot title (length as a little-endian int32, then characters)
2. Row label (length as a little-endian int32, then characters)
3. Column label (length as a little-endian int32, then characters)

Then, each sparsity pattern starts with:

1. Number of coordinates as a little-endian int32

followed by that many coordinates in the following format:

1. Row index as a little-endian int32
2. Column index as a little-endian int32
3. Sign as a character ('+' for positive, '-' for negative, or '0' for zero)

Parameters

[out]	file	A file stream.
[in]	mat	The sparse matrix.

Constructor & Destructor Documentation

Spy()

slp::Spy::Spy ( std::string_view filename, std::string_view title, std::string_view row_label, std::string_view col_label, int rows, int cols )

inline

Constructs a Spy instance.

Parameters

filename	The filename.
title	Plot title.
row_label	Row label.
col_label	Column label.
rows	The sparse matrix's number of rows.
cols	The sparse matrix's number of columns.

Member Function Documentation

add()

void slp::Spy::add ( const Eigen::SparseMatrix< double > & mat )

inline

Adds a matrix to the file.

Parameters

mat	The matrix.

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/util/spy.hpp