Class which contains data of a matlab workspace which can be written to a .mat file and loaded from matlab. More...

#include <MatlabWorkspace.h>

Public Member Functions
	MatlabWorkspace ()

	~MatlabWorkspace ()

void	clear ()
	Clear names and data of variables in workspace.

bool	write (const std::string &path) const
	Save current list of variables.

bool	read (const std::string &path)
	Load list of variables from .mat file.

template<typename DerivedM >
MatlabWorkspace &	save (const Eigen::PlainObjectBase< DerivedM > &M, const std::string &name)
	Assign data to a variable name in the workspace.

template<typename MT >
MatlabWorkspace &	save (const Eigen::SparseMatrix< MT > &M, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename ScalarM >
MatlabWorkspace &	save (const std::vector< std::vector< ScalarM > > &vM, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename ScalarV >
MatlabWorkspace &	save (const std::vector< ScalarV > &vV, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename Q >
MatlabWorkspace &	save (const Eigen::Quaternion< Q > &q, const std::string &name)

MatlabWorkspace &	save (const double d, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename DerivedM >
MatlabWorkspace &	save_index (const Eigen::DenseBase< DerivedM > &M, const std::string &name)
	Same as save() but adds 1 to each element, useful for saving "index" matrices like lists of faces or elements.

template<typename ScalarM >
MatlabWorkspace &	save_index (const std::vector< std::vector< ScalarM > > &vM, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename ScalarV >
MatlabWorkspace &	save_index (const std::vector< ScalarV > &vV, const std::string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename DerivedM >
bool	find (const std::string &name, Eigen::PlainObjectBase< DerivedM > &M)
	Find a certain matrix by name.

template<typename MT >
bool	find (const std::string &name, Eigen::SparseMatrix< MT > &M)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	find (const std::string &name, double &d)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	find (const std::string &name, int &v)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename DerivedM >
bool	find_index (const std::string &name, Eigen::PlainObjectBase< DerivedM > &M)
	Subtracts 1 from all entries.

template<typename DerivedM >
igl::matlab::MatlabWorkspace &	save (const Eigen::PlainObjectBase< DerivedM > &M, const std::string &name)

template<typename MT >
igl::matlab::MatlabWorkspace &	save (const Eigen::SparseMatrix< MT > &M, const std::string &name)

template<typename ScalarM >
igl::matlab::MatlabWorkspace &	save (const std::vector< std::vector< ScalarM > > &vM, const std::string &name)

template<typename ScalarV >
igl::matlab::MatlabWorkspace &	save (const std::vector< ScalarV > &vV, const std::string &name)

template<typename Q >
igl::matlab::MatlabWorkspace &	save (const Eigen::Quaternion< Q > &q, const std::string &name)

template<typename DerivedM >
igl::matlab::MatlabWorkspace &	save_index (const Eigen::DenseBase< DerivedM > &M, const std::string &name)

template<typename ScalarM >
igl::matlab::MatlabWorkspace &	save_index (const std::vector< std::vector< ScalarM > > &vM, const std::string &name)

template<typename ScalarV >
igl::matlab::MatlabWorkspace &	save_index (const std::vector< ScalarV > &vV, const std::string &name)

Detailed Description

Class which contains data of a matlab workspace which can be written to a .mat file and loaded from matlab.

This depends on matlab at compile time (though it shouldn't necessarily have to) but it does not depend on running the matlab engine at run-time.

Constructor & Destructor Documentation

◆ MatlabWorkspace()

igl::matlab::MatlabWorkspace::MatlabWorkspace ( )

inline

◆ ~MatlabWorkspace()

igl::matlab::MatlabWorkspace::~MatlabWorkspace ( )

inline

Member Function Documentation

◆ clear()

void igl::matlab::MatlabWorkspace::clear ( )

inline

Clear names and data of variables in workspace.

◆ write()

bool igl::matlab::MatlabWorkspace::write ( const std::string & path ) const

inline

Save current list of variables.

Parameters

[in] path path to .mat file

Returns: true on success, false on failure

◆ read()

bool igl::matlab::MatlabWorkspace::read ( const std::string & path )

inline

Load list of variables from .mat file.

Parameters

[in] path path to .mat file

Returns: true on success, false on failure

◆ save() [1/11]

template<typename DerivedM >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::PlainObjectBase< DerivedM > &	M,
		const std::string &	name
	)

inline

Assign data to a variable name in the workspace.

Template Parameters

DerivedM eigen matrix (e.g. MatrixXd)

Parameters

[in]	M	data (usually a matrix)
[in]	name	variable name to save into work space

Returns: true on success, false on failure

◆ save() [2/11]

template<typename MT >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::SparseMatrix< MT > &	M,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

MT	sparse matrix type (e.g. double)

◆ save() [3/11]

template<typename ScalarM >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const std::vector< std::vector< ScalarM > > &	vM,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

ScalarM scalar type, e.g. double

◆ save() [4/11]

template<typename ScalarV >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const std::vector< ScalarV > &	vV,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

ScalarV scalar type, e.g. double

◆ save() [5/11]

template<typename Q >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::Quaternion< Q > &	q,
		const std::string &	name
	)

inline

Template Parameters

Q	quaternion type

NOTE: Eigen stores quaternions coefficients as (i,j,k,1), but most of our matlab code stores them as (1,i,j,k) This takes a quaternion and saves it as a (1,i,j,k) row vector

◆ save() [6/11]

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const double	d,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ save_index() [1/6]

template<typename DerivedM >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const Eigen::DenseBase< DerivedM > &	M,
		const std::string &	name
	)

inline

Same as save() but adds 1 to each element, useful for saving "index" matrices like lists of faces or elements.

Template Parameters

DerivedM eigen matrix (e.g. MatrixXd)

◆ save_index() [2/6]

template<typename ScalarM >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const std::vector< std::vector< ScalarM > > &	vM,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

MT	sparse matrix type (e.g. double)

◆ save_index() [3/6]

template<typename ScalarV >

MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const std::vector< ScalarV > &	vV,
		const std::string &	name
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

ScalarV scalar type, e.g. double

◆ find() [1/4]

template<typename DerivedM >

bool igl::matlab::MatlabWorkspace::find	(	const std::string &	name,
		Eigen::PlainObjectBase< DerivedM > &	M
	)

inline

Find a certain matrix by name.

Template Parameters

DerivedM eigen matrix (e.g. MatrixXd)

Parameters

[in]	name	exact name of matrix as string
[out]	M	matrix

Returns: true only if found.

◆ find() [2/4]

template<typename MT >

bool igl::matlab::MatlabWorkspace::find	(	const std::string &	name,
		Eigen::SparseMatrix< MT > &	M
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

MT	sparse matrix type (e.g. double)

◆ find() [3/4]

bool igl::matlab::MatlabWorkspace::find	(	const std::string &	name,
		double &	d
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find() [4/4]

bool igl::matlab::MatlabWorkspace::find	(	const std::string &	name,
		int &	v
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ find_index()

template<typename DerivedM >

bool igl::matlab::MatlabWorkspace::find_index	(	const std::string &	name,
		Eigen::PlainObjectBase< DerivedM > &	M
	)

inline

Subtracts 1 from all entries.

Template Parameters

DerivedM eigen matrix (e.g. MatrixXd)

Parameters

[in]	name	exact name of matrix as string
[out]	M	matrix

◆ save() [7/11]

template<typename DerivedM >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::PlainObjectBase< DerivedM > &	M,
		const std::string &	name
	)

inline

◆ save() [8/11]

template<typename MT >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::SparseMatrix< MT > &	M,
		const std::string &	name
	)

inline

◆ save() [9/11]

template<typename ScalarM >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const std::vector< std::vector< ScalarM > > &	vM,
		const std::string &	name
	)

inline

◆ save() [10/11]

template<typename ScalarV >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const std::vector< ScalarV > &	vV,
		const std::string &	name
	)

inline

◆ save() [11/11]

template<typename Q >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save	(	const Eigen::Quaternion< Q > &	q,
		const std::string &	name
	)

inline

◆ save_index() [4/6]

template<typename DerivedM >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const Eigen::DenseBase< DerivedM > &	M,
		const std::string &	name
	)

inline

◆ save_index() [5/6]

template<typename ScalarM >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const std::vector< std::vector< ScalarM > > &	vM,
		const std::string &	name
	)

inline

◆ save_index() [6/6]

template<typename ScalarV >

igl::matlab::MatlabWorkspace & igl::matlab::MatlabWorkspace::save_index	(	const std::vector< ScalarV > &	vV,
		const std::string &	name
	)

inline

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

include/igl/matlab/MatlabWorkspace.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MatlabWorkspace()

◆ ~MatlabWorkspace()

Member Function Documentation

◆ clear()

◆ write()

◆ read()

◆ save() [1/11]

◆ save() [2/11]

◆ save() [3/11]

◆ save() [4/11]

◆ save() [5/11]

◆ save() [6/11]

◆ save_index() [1/6]

◆ save_index() [2/6]

◆ save_index() [3/6]

◆ find() [1/4]

◆ find() [2/4]

◆ find() [3/4]

◆ find() [4/4]

◆ find_index()

◆ save() [7/11]

◆ save() [8/11]

◆ save() [9/11]

◆ save() [10/11]

◆ save() [11/11]

◆ save_index() [4/6]

◆ save_index() [5/6]

◆ save_index() [6/6]