OGF::NL::Blas Class Reference

Wrapper class for BLAS operations on vectors (Basic Linear Algebra). More...

#include <OGF/scene_graph/NL/blas.h>

Inheritance diagram for OGF::NL::Blas:

Public Member Functions
	Blas ()
	Blas constructor.
	~Blas () override
	Blas destructor.
void	scal (double a, Vector *x)
	Scales a vector.
double	dot (const Vector *x, const Vector *y)
	Computes the dot product between two vectors.
double	nrm2 (const Vector *x)
	Computes the norm of a vector.
void	axpy (double a, const Vector *x, Vector *y)
	Computes a linear combination of two vectors.
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
	: void copy(const Vector* x
Vector *	y
Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const
	: bool equals(const Object* other) const

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.
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.

Detailed Description

Wrapper class for BLAS operations on vectors (Basic Linear Algebra).

Definition at line 55 of file blas.h.

Member Function Documentation

axpy()

void OGF::NL::Blas::axpy	(	double	a,
		const Vector *	x,
		Vector *	y
	)

Computes a linear combination of two vectors.

In formula: \( y \leftarrow a x + y \)

Parameters

[in]	a	scaling coefficient
[in]	x	source vector to be scaled and added
[in,out]	y	the vector that a x should be added to

dot()

double OGF::NL::Blas::dot	(	const Vector *	x,
		const Vector *	y
	)

Computes the dot product between two vectors.

Parameters

[in]	x	first vector
[in]	y	second vector

Returns

the dot product between x and y

nrm2()

double OGF::NL::Blas::nrm2

(

const Vector *

x

)

Computes the norm of a vector.

Equivalent to sqrt(dot(x,x))

Parameters

[in]

x

the vector

Returns

the norm of x

scal()

void OGF::NL::Blas::scal	(	double	a,
		Vector *	x
	)

Scales a vector.

In formula: \( x \leftarrow a x \)

Parameters

[in]	a	scaling coefficient
[in,out]	x	vector to be scaled

Member Data Documentation

__pad0__

OGF::NL::Blas::__pad0__

Definition at line 65 of file blas.h.

y

Vector* OGF::NL::Blas::y

Definition at line 75 of file blas.h.

---

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

• OGF/scene_graph/NL/blas.h