xcsf/neural__layer__softmax_8h_source.html

/*

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program.  If not, see <http://www.gnu.org/licenses/>.

 */


#pragma once


#include "neural_layer.h"


void

neural_layer_softmax_init(struct Layer *l, const struct ArgsLayer *args);


struct Layer *

neural_layer_softmax_copy(const struct Layer *src);


void

neural_layer_softmax_rand(struct Layer *l);


void

neural_layer_softmax_forward(const struct Layer *l, const struct Net *net,

                             const double *input);

void

neural_layer_softmax_backward(const struct Layer *l, const struct Net *net,

                              const double *input, double *delta);


void

neural_layer_softmax_update(const struct Layer *l);


void

neural_layer_softmax_print(const struct Layer *l, const bool print_weights);


bool

neural_layer_softmax_mutate(struct Layer *l);


void

neural_layer_softmax_free(const struct Layer *l);


double *

neural_layer_softmax_output(const struct Layer *l);


size_t

neural_layer_softmax_save(const struct Layer *l, FILE *fp);


size_t

neural_layer_softmax_load(struct Layer *l, FILE *fp);


void

neural_layer_softmax_resize(struct Layer *l, const struct Layer *prev);


char *

neural_layer_softmax_json_export(const struct Layer *l,

                                 const bool return_weights);


static struct LayerVtbl const layer_softmax_vtbl = {

    &neural_layer_softmax_init,     &neural_layer_softmax_mutate,

    &neural_layer_softmax_resize,   &neural_layer_softmax_copy,

    &neural_layer_softmax_free,     &neural_layer_softmax_rand,

    &neural_layer_softmax_print,    &neural_layer_softmax_update,

    &neural_layer_softmax_backward, &neural_layer_softmax_forward,

    &neural_layer_softmax_output,   &neural_layer_softmax_save,

    &neural_layer_softmax_load,     &neural_layer_softmax_json_export

};


neural_layer.h
Interface for neural network layers.

neural_layer_softmax_backward
void neural_layer_softmax_backward(const struct Layer *l, const struct Net *net, const double *input, double *delta)
Backward propagates a softmax layer.
Definition neural_layer_softmax.c:142

neural_layer_softmax_json_export
char * neural_layer_softmax_json_export(const struct Layer *l, const bool return_weights)
Returns a json formatted string representation of a softmax layer.
Definition neural_layer_softmax.c:185

neural_layer_softmax_free
void neural_layer_softmax_free(const struct Layer *l)
Free memory used by a softmax layer.
Definition neural_layer_softmax.c:234

neural_layer_softmax_copy
struct Layer * neural_layer_softmax_copy(const struct Layer *src)
Initialises and creates a copy of one softmax layer from another.
Definition neural_layer_softmax.c:75

neural_layer_softmax_load
size_t neural_layer_softmax_load(struct Layer *l, FILE *fp)
Reads a softmax layer from a file.
Definition neural_layer_softmax.c:274

layer_softmax_vtbl
static struct LayerVtbl const layer_softmax_vtbl
Neural softmax layer implemented functions.
Definition neural_layer_softmax.h:75

neural_layer_softmax_print
void neural_layer_softmax_print(const struct Layer *l, const bool print_weights)
Prints a softmax layer.
Definition neural_layer_softmax.c:170

neural_layer_softmax_init
void neural_layer_softmax_init(struct Layer *l, const struct ArgsLayer *args)
Creates and initialises a softmax layer.
Definition neural_layer_softmax.c:57

neural_layer_softmax_save
size_t neural_layer_softmax_save(const struct Layer *l, FILE *fp)
Writes a softmax layer to a file.
Definition neural_layer_softmax.c:257

neural_layer_softmax_forward
void neural_layer_softmax_forward(const struct Layer *l, const struct Net *net, const double *input)
Forward propagates a softmax layer.
Definition neural_layer_softmax.c:113

neural_layer_softmax_update
void neural_layer_softmax_update(const struct Layer *l)
Dummy function since a softmax layer has no weights.
Definition neural_layer_softmax.c:159

neural_layer_softmax_rand
void neural_layer_softmax_rand(struct Layer *l)
Dummy function since softmax layers have no weights.
Definition neural_layer_softmax.c:101

neural_layer_softmax_resize
void neural_layer_softmax_resize(struct Layer *l, const struct Layer *prev)
Resizes a softmax layer if the previous layer has changed size.
Definition neural_layer_softmax.c:217

neural_layer_softmax_mutate
bool neural_layer_softmax_mutate(struct Layer *l)
Dummy function since a softmax layer cannot be mutated.
Definition neural_layer_softmax.c:205

neural_layer_softmax_output
double * neural_layer_softmax_output(const struct Layer *l)
Returns the output from a softmax layer.
Definition neural_layer_softmax.c:245

ArgsLayer
Parameters for initialising a neural network layer.
Definition neural_layer_args.h:31

LayerVtbl
Neural network layer interface data structure.
Definition neural_layer.h:143

Layer
Neural network layer data structure.
Definition neural_layer.h:73

Layer::delta
double * delta
Delta for updating weights.
Definition neural_layer.h:83

Net
Neural network data structure.
Definition neural.h:48