SHOGUN  6.1.0
CDenseMatrixOperator< T > Singleton Reference

## Detailed Description

### template<class T> singleton shogun::CDenseMatrixOperator< T >

Class that represents a dense-matrix linear operator. It computes matrix-vector product $$Ax$$ in its apply method, $$A\in\mathbb{C}^{m\times n},A:\mathbb{C}^{n}\rightarrow \mathbb{C}^{m}$$ being the matrix operator and $$x\in\mathbb{C}^{n}$$ being the vector. The result is a vector $$y\in\mathbb{C}^{m}$$.

Definition at line 19 of file DirectEigenSolver.h.

Inheritance diagram for CDenseMatrixOperator< T >:
[legend]

## Public Member Functions

CDenseMatrixOperator ()

CDenseMatrixOperator (SGMatrix< T > op)

CDenseMatrixOperator (const CDenseMatrixOperator< T > &orig)

~CDenseMatrixOperator ()

virtual SGVector< T > apply (SGVector< T > b) const

virtual void set_diagonal (SGVector< T > diag)

virtual SGVector< T > get_diagonal () const

SGMatrix< T > get_matrix_operator () const

template<class Scalar >
operator CDenseMatrixOperator< Scalar > * () const

virtual const char * get_name () const

const index_t get_dimension () const

int32_t ref ()

int32_t ref_count ()

int32_t unref ()

virtual CSGObjectshallow_copy () const

virtual CSGObjectdeep_copy () const

virtual bool is_generic (EPrimitiveType *generic) const

template<class T >
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

void unset_generic ()

virtual void print_serializable (const char *prefix="")

virtual bool save_serializable (CSerializableFile *file, const char *prefix="")

virtual bool load_serializable (CSerializableFile *file, const char *prefix="")

void set_global_io (SGIO *io)

SGIOget_global_io ()

void set_global_parallel (Parallel *parallel)

Parallelget_global_parallel ()

void set_global_version (Version *version)

Versionget_global_version ()

SGStringList< char > get_modelsel_names ()

void print_modsel_params ()

char * get_modsel_param_descr (const char *param_name)

index_t get_modsel_param_index (const char *param_name)

void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)

bool has (const std::string &name) const

template<typename T >
bool has (const Tag< T > &tag) const

template<typename T , typename U = void>
bool has (const std::string &name) const

template<typename T >
void set (const Tag< T > &_tag, const T &value)

template<typename T , typename U = void>
void set (const std::string &name, const T &value)

template<typename T >
get (const Tag< T > &_tag) const

template<typename T , typename U = void>
get (const std::string &name) const

virtual void update_parameter_hash ()

virtual bool parameter_hash_changed ()

virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)

virtual CSGObjectclone ()

## Public Attributes

SGIOio

Parallelparallel

Versionversion

Parameterm_parameters

Parameterm_model_selection_parameters

uint32_t m_hash

## Protected Member Functions

virtual void load_serializable_pre () throw (ShogunException)

virtual void load_serializable_post () throw (ShogunException)

virtual void save_serializable_pre () throw (ShogunException)

virtual void save_serializable_post () throw (ShogunException)

template<typename T >
void register_param (Tag< T > &_tag, const T &value)

template<typename T >
void register_param (const std::string &name, const T &value)

bool clone_parameters (CSGObject *other)

## Protected Attributes

index_t m_dimension

## Constructor & Destructor Documentation

 CDenseMatrixOperator ( )

default constructor

Definition at line 24 of file DenseMatrixOperator.cpp.

 CDenseMatrixOperator ( SGMatrix< T > op )
explicit

constructor

Parameters
 op the dense matrix to be used as the linear operator

Definition at line 33 of file DenseMatrixOperator.cpp.

 CDenseMatrixOperator ( const CDenseMatrixOperator< T > & orig )

copy constructor that creates a deep copy

Parameters
 orig the original dense matrix operator

Definition at line 43 of file DenseMatrixOperator.cpp.

 ~CDenseMatrixOperator ( )

destructor

Definition at line 69 of file DenseMatrixOperator.cpp.

## Member Function Documentation

 SGVector< T > apply ( SGVector< T > b ) const
virtual

method that applies the dense-matrix linear operator to a vector

Parameters
 b the vector to which the linear operator applies
Returns
the result vector

Implements CMatrixOperator< T >.

Definition at line 118 of file DenseMatrixOperator.cpp.

 void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > * dict )
inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters
 dict dictionary of parameters to be built.

Definition at line 628 of file SGObject.cpp.

 CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 727 of file SGObject.cpp.

 bool clone_parameters ( CSGObject * other )
protectedinherited

Definition at line 752 of file SGObject.cpp.

 CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 229 of file SGObject.cpp.

 bool equals ( CSGObject * other, float64_t accuracy = 0.0, bool tolerant = false )
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters
 other object to compare with accuracy accuracy to use for comparison (optional) tolerant allows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 649 of file SGObject.cpp.

 T get ( const Tag< T > & _tag ) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
 _tag name and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 368 of file SGObject.h.

 T get ( const std::string & name ) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
 name name of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 391 of file SGObject.h.

 SGVector< T > get_diagonal ( ) const
virtual

method that returns the main diagonal of the matrix

Returns
the diagonal

Implements CMatrixOperator< T >.

Definition at line 81 of file DenseMatrixOperator.cpp.

 const index_t get_dimension ( ) const
inherited
Returns
the dimension on which the linear operator can apply

Definition at line 37 of file LinearOperator.cpp.

 SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 266 of file SGObject.cpp.

 Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 308 of file SGObject.cpp.

 Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 321 of file SGObject.cpp.

 SGMatrix< T > get_matrix_operator ( ) const
Returns
the dense matrix operator

Definition at line 75 of file DenseMatrixOperator.cpp.

 SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 529 of file SGObject.cpp.

 char * get_modsel_param_descr ( const char * param_name )
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
 param_name name of the parameter
Returns
description of the parameter

Definition at line 553 of file SGObject.cpp.

 index_t get_modsel_param_index ( const char * param_name )
inherited

Returns index of model selection parameter with provided index

Parameters
 param_name name of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 566 of file SGObject.cpp.

 virtual const char* get_name ( ) const
virtual
Returns
object name

Reimplemented from CMatrixOperator< T >.

Definition at line 98 of file DenseMatrixOperator.h.

 bool has ( const std::string & name ) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
 name name of the parameter
Returns
true if the parameter exists with the input name

Definition at line 291 of file SGObject.h.

 bool has ( const Tag< T > & tag ) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
 tag tag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 302 of file SGObject.h.

 bool has ( const std::string & name ) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
 name name of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 313 of file SGObject.h.

 bool is_generic ( EPrimitiveType * generic ) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
 generic set to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 327 of file SGObject.cpp.

 bool load_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
 file where to load from prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 400 of file SGObject.cpp.

 void load_serializable_post ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 457 of file SGObject.cpp.

 void load_serializable_pre ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 452 of file SGObject.cpp.

 operator CDenseMatrixOperator< Scalar > * ( ) const

create a new dense matrix operator of Scalar type

Definition at line 83 of file DenseMatrixOperator.h.

 bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 293 of file SGObject.cpp.

 void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 505 of file SGObject.cpp.

 void print_serializable ( const char * prefix = "" )
virtualinherited

prints registered parameters out

Parameters
 prefix prefix for members

Definition at line 339 of file SGObject.cpp.

 int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 183 of file SGObject.cpp.

 int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 190 of file SGObject.cpp.

 void register_param ( Tag< T > & _tag, const T & value )
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
 _tag name and type information of parameter value value of the parameter

Definition at line 442 of file SGObject.h.

 void register_param ( const std::string & name, const T & value )
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
 name name of the parameter value value of the parameter along with type information

Definition at line 455 of file SGObject.h.

 bool save_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Save this object to file.

Parameters
 file where to save the object; will be closed during returning if PREFIX is an empty string. prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 345 of file SGObject.cpp.

 void save_serializable_post ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 467 of file SGObject.cpp.

 void save_serializable_pre ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 462 of file SGObject.cpp.

 void set ( const Tag< T > & _tag, const T & value )
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
 _tag name and type information of parameter value value of the parameter

Definition at line 329 of file SGObject.h.

 void set ( const std::string & name, const T & value )
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
 name name of the parameter value value of the parameter along with type information

Definition at line 355 of file SGObject.h.

 void set_diagonal ( SGVector< T > diag )
virtual

method that sets the main diagonal of the matrix

Parameters
 diag the diagonal to be set

Implements CMatrixOperator< T >.

Definition at line 99 of file DenseMatrixOperator.cpp.

 void set_generic ( )
inherited

Definition at line 74 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 144 of file SGObject.cpp.

 void set_generic ( )
inherited

set generic type to T

 void set_global_io ( SGIO * io )
inherited

set the io object

Parameters
 io io object to use

Definition at line 259 of file SGObject.cpp.

 void set_global_parallel ( Parallel * parallel )
inherited

set the parallel object

Parameters
 parallel parallel object to use

Definition at line 272 of file SGObject.cpp.

 void set_global_version ( Version * version )
inherited

set the version object

Parameters
 version version object to use

Definition at line 314 of file SGObject.cpp.

 CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 223 of file SGObject.cpp.

 int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 197 of file SGObject.cpp.

 void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 334 of file SGObject.cpp.

 void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 279 of file SGObject.cpp.

## Member Data Documentation

 SGIO* io
inherited

io

Definition at line 550 of file SGObject.h.

 index_t m_dimension
protectedinherited

the dimension of vector on which the linear operator can apply

Definition at line 58 of file LinearOperator.h.

inherited

parameters wrt which we can compute gradients

Definition at line 565 of file SGObject.h.

 uint32_t m_hash
inherited

Hash of parameter values

Definition at line 568 of file SGObject.h.

 Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 562 of file SGObject.h.

 Parameter* m_parameters
inherited

parameters

Definition at line 559 of file SGObject.h.

 Parallel* parallel
inherited

parallel

Definition at line 553 of file SGObject.h.

 Version* version
inherited

version

Definition at line 556 of file SGObject.h.

The documentation for this singleton was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation