Inheritance diagram for OGF::NL::Matrix:

Public Types
enum	Format { Dynamic , CRS , Factorized }
	Internal format of a matrix. More...

enum	Factorization { SuperLU , SuperLU_perm , SuperLU_sym , Cholmod }
	Factorization methods. More...

enum	IterativeSolver { CG , GMRES , BiCGSTAB }
	Iterative Solvers. More...

enum	Preconditioner { None , Jacobi , SSOR }
	Preconditioners. More...

Public Member Functions
	Matrix (index_t m, index_t n)
	Matrix constructor.

	~Matrix () override
	Matrix destructor.

index_t	get_n () const
	Gets the number of columns.

Format	get_format () const
	Gets the format of the matrix.

void	add_coefficients (const Vector I, const Vector J, const Vector *A, bool ignore_OOB=false)
	Adds a vector of coefficient.

void	add_coefficients_to_diagonal (const Vector *A)
	Adds a vector of coefficient.

void	mult (const Vector x, Vector y) const
	Computes a matrix vector product.

void	compress ()
	Compresses the matrix from the dynamic format to the CRS format.

Matrix *	factorize (Factorization factorization) const
	Factorizes the matrix.

void	solve_iterative (const Vector b, Vector x, IterativeSolver solver=BiCGSTAB, Preconditioner precond=None, index_t max_iter=1000, double eps=1e-3)
	Solves a linear system using an iterative solver.

void	solve_direct (const Vector b, Vector x, Factorization factorization=SuperLU_perm)
	Solves a linear system using a direct solver.

void	solve_symmetric (const Vector b, Vector x, bool direct_solver=false)
	Solves a linear system with a symmetric matrix using default paramerers.

NLMatrix	implementation () const
	Gets the underlying OpenNL implementation.

Public Member Functions inherited from OGF::Object
	Object (bool transient=false)
	Object constructor.

	~Object () override
	Object destructor.

virtual MetaClass *	meta_class () const
	Gets the meta class.

virtual void	set_meta_class (MetaClass *mclass)
	Sets the meta class.

unsigned int	id () const
	Gets the identifier of this object.

std::string	string_id () const
	Gets the unique string identifier.

bool	has_method (const std::string &method_name) const
	Tests whether a method is defined.

virtual bool	invoke_method (const std::string &method_name, const ArgList &args, Any &ret_val)
	Invokes a method by method name and argument list, and gets the return value.

bool	invoke_method (const std::string &method_name, const ArgList &args)
	Invokes a method by method name and argument list.

bool	invoke_method (const std::string &method_name)
	Invokes a method by method name.

bool	has_property (const std::string &prop_name) const
	Tests whether a property is defined.

virtual bool	get_property (const std::string &prop_name, std::string &prop_value) const
	Gets a property.

virtual Connection *	connect_signal_to_slot (const std::string &signal_name, Object *to, const std::string &slot_name)
	Connects a signal with a slot of another object.

virtual void	add_connection (Connection *connection)
	Adds a connection to this object.

virtual void	remove_connection (Connection *connection)
	Removes a connection to this object.

virtual void	get_element (index_t i, Any &value) const
	Gets an element by index.

virtual void	set_element (index_t i, const Any &value)
	Sets an element by index.

void	get_element (index_t item, index_t component, Any &value) const
	Gets an element by item and component.

void	set_element (index_t item, index_t component, const Any &value)
	Sets an element by item and component.

virtual void	search (const std::string &needle, const std::string &path="")
	Displays the names of all objects that contain a substring.

virtual index_t	get_dimension () const
	Gets the number of elements per item.

bool	get_signals_enabled () const
	Tests wheter signals are enabled.

void	set_signals_enabled (bool value)
	Enables or disables signals.

bool	get_slots_enabled () const
	Tests wheter slots are enabled.

void	set_slots_enabled (bool value)
	Enables or disables slots.

MetaClass *	get_meta_class () const
	Gets the meta class.

std::string	get_string_id () const
	Gets the unique string identifier.

virtual std::string	get_doc () const
	Gets the documentation.

virtual Sign	compare (const Object *other) const
	Compares this object with another one.

virtual bool	is_a (const MetaType *type) const
	Tests whether this object inherits a given type.

void	disconnect ()
	Removes all connections from signals of this objects.

void	enable_signals ()
	Enables signals.

void	disable_signals ()
	Disables signals.

void	enable_slots ()
	Enables slots.

void	disable_slots ()
	Disables slots.

void	set_properties (const ArgList &args)
	Sets several properties in a single call.

virtual bool	set_property (const std::string &name, const std::string &value)
	Sets an individual property.

void	help () const
	Displays some help about this object.

virtual bool	set_property (const std::string &name, const Any &value)
	Sets an individual property.

virtual bool	get_property (const std::string &prop_name, Any &prop_value) const
	Gets a property.

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.

void	unref () const
	Decrements the reference count.

bool	is_shared () const
	Check if the object is shared.

int	nb_refs () const
	Gets the number of references that point to this object.

Public Attributes
	: index_t get_m() const

	: void add_coefficient(index_t i

index_t	j

index_t double	a

Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const

	: bool equals(const Object* other) const

Protected Member Functions
	Matrix (NLMatrix impl)
	Matrix constructor.

Protected Member Functions inherited from OGF::Object
virtual bool	emit_signal (const std::string &signal_name, const ArgList &args, bool called_from_slot=false)
	Emits a signal and calls the slots it is connected to.

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.

virtual	~Counted ()
	Destroys a reference counted object.

Additional Inherited Members
Static Public Member Functions inherited from OGF::Object
static Object *	id_to_object (unsigned int id)
	Gets an object from a unique object id.

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.

static void	unref (const Counted *counted)
	Decrements the reference count.

Detailed Description

Definition at line 51 of file matrix.h.

Member Enumeration Documentation

◆ Factorization

enum OGF::NL::Matrix::Factorization

Factorization methods.

Definition at line 62 of file matrix.h.

◆ Format

enum OGF::NL::Matrix::Format

Internal format of a matrix.

Definition at line 57 of file matrix.h.

◆ IterativeSolver

enum OGF::NL::Matrix::IterativeSolver

Iterative Solvers.

Definition at line 67 of file matrix.h.

◆ Preconditioner

enum OGF::NL::Matrix::Preconditioner

Preconditioners.

Definition at line 72 of file matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

OGF::NL::Matrix::Matrix	(	index_t	m,
		index_t	n
	)

Matrix constructor.

Parameters

[in]	m	number of rows.
[in]	n	number of columns.

◆ Matrix() [2/2]

OGF::NL::Matrix::Matrix ( NLMatrix impl )

inlineprotected

Matrix constructor.

Parameters

[in] impl a pointer to the OpenNL implementation.

For internal use only.

Definition at line 229 of file matrix.h.

Member Function Documentation

◆ add_coefficients()

void OGF::NL::Matrix::add_coefficients	(	const Vector *	I,
		const Vector *	J,
		const Vector *	A,
		bool	ignore_OOB = `false`
	)

Adds a vector of coefficient.

If the coefficient already exists, or if there are duplicated entries, a is added to its previous value.

Parameters

[in]	I	vector of row indices, should be integers
[in]	J	vector of column indices, should be integers
[in]	A	vector of values to be added, should be doubles
[in]	ignore_OOB	if set, ignores out-of-bound indices, else reports errors on out-of-bound indices.

◆ add_coefficients_to_diagonal()

void OGF::NL::Matrix::add_coefficients_to_diagonal ( const Vector * A )

Adds a vector of coefficient.

Parameters

[in] A vector of values to be added, should be doubles and size should be smaller than min(m,n)

◆ compress()

void OGF::NL::Matrix::compress ( )

Compresses the matrix from the dynamic format to the CRS format.

When the matrix is compressed, matrix vector product are faster, but add_coefficient() can no longer be called.

◆ factorize()

Matrix * OGF::NL::Matrix::factorize ( Factorization factorization ) const

Factorizes the matrix.

This depends on OpenNL extensions that may be unsupported on the architecture.

Parameters

[in]

factorization

one of

SuperLU : plain SuperLU algorithm
SuperLU_perm : SuperLU with permutation
SuperLU_sym : SuperLU with permutation for symmetric matrix
CHOLMOD : modified Cholesky (for symmetric matrix)

◆ get_format()

Format OGF::NL::Matrix::get_format ( ) const

Gets the format of the matrix.

Return values

Dynamic	is the default format. Supports add_coefficient()
CRS	for Compressed Row Storage.
Factorized	for solving linear systems.

◆ get_n()

index_t OGF::NL::Matrix::get_n ( ) const

Gets the number of columns.

Returns: the number of columns.

◆ implementation()

NLMatrix OGF::NL::Matrix::implementation ( ) const

inline

Gets the underlying OpenNL implementation.

Returns: a pointer to the NLMatrix.

Definition at line 218 of file matrix.h.

◆ mult()

void OGF::NL::Matrix::mult	(	const Vector *	x,
		Vector *	y
	)		const

Computes a matrix vector product.

Parameters

[in]	x	the vector to be multiplied. Should have n elements.
[out]	y	the result. Should have m elements.

◆ solve_direct()

void OGF::NL::Matrix::solve_direct	(	const Vector *	b,
		Vector *	x,
		Factorization	factorization = `SuperLU_perm`
	)

Solves a linear system using a direct solver.

Parameters

[in]	b	the right hand side
[out]	x	the solution
[in]	factorization	one of SuperLU, SuperLU_perm, SuperLU_sym, Cholmod

◆ solve_iterative()

void OGF::NL::Matrix::solve_iterative	(	const Vector *	b,
		Vector *	x,
		IterativeSolver	solver = `BiCGSTAB`,
		Preconditioner	precond = `None`,
		index_t	max_iter = `1000`,
		double	eps = `1e-3`
	)

Solves a linear system using an iterative solver.

Parameters

[in]	b	the right hand side
[out]	x	the solution
[in]	solver	one of CG, GMRES, BiCGSTAB
[in]	precond	one of None, Jacobi, SSOR
[in]	max_iter	maximum number of iterations
[in]	eps	convergence criterion. Iterations are stopped whenever \( \\| Ax - b\\| / \\| b \\| \) is smaller than eps.

◆ solve_symmetric()

void OGF::NL::Matrix::solve_symmetric	(	const Vector *	b,
		Vector *	x,
		bool	direct_solver = `false`
	)

Solves a linear system with a symmetric matrix using default paramerers.

Parameters

[in]	b	the right hand side
[out]	x	the solution
[in]	direct_solver	if true, tentatively use a direct solver.

Member Data Documentation

◆ pad0

OGF::NL::Matrix::__pad0__

Definition at line 84 of file matrix.h.

◆ pad1

OGF::NL::Matrix::__pad1__

Definition at line 105 of file matrix.h.

◆ a

index_t double OGF::NL::Matrix::a

Definition at line 117 of file matrix.h.

◆ j

index_t OGF::NL::Matrix::j

Definition at line 117 of file matrix.h.

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

OGF/scene_graph/NL/matrix.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Factorization

◆ Format

◆ IterativeSolver

◆ Preconditioner

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

Member Function Documentation

◆ add_coefficients()

◆ add_coefficients_to_diagonal()

◆ compress()

◆ factorize()

◆ get_format()

◆ get_n()

◆ implementation()

◆ mult()

◆ solve_direct()

◆ solve_iterative()

◆ solve_symmetric()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ a

◆ j

◆ pad0

◆ pad1