Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

gnn_memory_output : Memory Output Samples.
[gnn_output : Writing sets of vectors.]


Detailed Description

The gnn_memory_output : Memory Output Samples. samples set stores its samples in memory. Internally, it contains a matrix, where the output samples are stored row-wise, so the matrix can be retrieved.

A gnn_memory_output : Memory Output Samples. can be build directly providing a matrix of the required size using the gnn_memory_output_new_from_matrix. Alternatively, it can be built just by indicating the number of outputs that it should be able to store, and their size.

Typedefs

typedef _gnn_memory_output gnn_memory_output
 The datatype for memory outputs.


Functions

int gnn_memory_output_put (gnn_output *set, size_t k, const gsl_vector *v)
 The "put" function for a memory output set.

void gnn_memory_output_destroy (gnn_output *set)
 Destroy function.

gnn_outputgnn_memory_output_new (size_t size, size_t n)
 Builds an output set for required sizes.

gnn_outputgnn_memory_output_new_from_matrix (gsl_matrix *m)
 Builds an output set from a matrix.

const gsl_matrix * gnn_memory_output_get_matrix (gnn_output *set)
 Returns the set's internal matrix.

int gnn_memory_output_save (gnn_output *set, const char *filename)
 Saves the outputs to a file.


Typedef Documentation

typedef struct _gnn_memory_output gnn_memory_output
 

This is the datatype for memory outputs. It extends the basic gnn_output : Writing sets of vectors. structure to include the additional pointer to the output samples matrix, and a vector view.

Definition at line 65 of file gnn_memory_output.c.


Function Documentation

void gnn_memory_output_destroy gnn_output   set [static]
 

This is the gnn_memory_output : Memory Output Samples. destroy function.

Parameters:
set  A pointer to a gnn_memory_output : Memory Output Samples. dataset.

Definition at line 130 of file gnn_memory_output.c.

const gsl_matrix* gnn_memory_output_get_matrix gnn_output   set
 

This function returns a pointer to the set's internal matrix. This matrix stores the output vectors row-wise.

Parameters:
set  A pointer to a gnn_output : Writing sets of vectors..
Returns:
Returns a pointer to the internal matrix.

Definition at line 250 of file gnn_memory_output.c.

gnn_output* gnn_memory_output_new size_t    size,
size_t    n
 

This function creates a new gnn_memory_output : Memory Output Samples. that should be able to store the given number of patterns, where the sample's size is also given.

Parameters:
size  The number of patterns to be stored by the output.
n  The size of an output sample vector.
Returns:
Returns a pointer to a new gnn_memory_output : Memory Output Samples. set.

Definition at line 163 of file gnn_memory_output.c.

gnn_output* gnn_memory_output_new_from_matrix gsl_matrix *    m
 

This function creates a new gnn_memory_output : Memory Output Samples. from a matrix, where the samples are stored row-wise. That is, each row will contain a different sample, and each column corresponds to a different sample's component.

Parameters:
m  The output sample matrix.
Returns:
Returns a pointer to a new gnn_memory_output : Memory Output Samples. set.

Definition at line 203 of file gnn_memory_output.c.

int gnn_memory_output_put gnn_output   set,
size_t    k,
const gsl_vector *    v
[static]
 

This function stores the k-th pattern in the set.

Parameters:
set  A pointer to a gnn_memory_output : Memory Output Samples..
k  The index of the pattern to be stored.
v  A pointer to the output vector to be stored.
Returns:
Returns 0 if suceeded.

Definition at line 98 of file gnn_memory_output.c.

int gnn_memory_output_save gnn_output   set,
const char *    filename
 

This function saves the outputs stored in the matrix to a file, in plain ASCII format.

Parameters:
set  A pointer to the output set.
filename  A string with the name of the output file.
Returns:
Returns 0 if succeeded.

Definition at line 272 of file gnn_memory_output.c.


Generated on Sun Jun 13 20:51:44 2004 for libgnn Gradient Retropropagation Machine Library by doxygen1.2.18