XCSF  1.4.7
XCSF learning classifier system
neural_layer_lstm.h
Go to the documentation of this file.
1 /*
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation, either version 3 of the License, or
5  * (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  */
15 
24 #pragma once
25 
26 #include "neural_layer.h"
27 
28 void
29 neural_layer_lstm_init(struct Layer *l, const struct ArgsLayer *args);
30 
31 struct Layer *
32 neural_layer_lstm_copy(const struct Layer *src);
33 
34 void
35 neural_layer_lstm_rand(struct Layer *l);
36 
37 void
38 neural_layer_lstm_forward(const struct Layer *l, const struct Net *net,
39  const double *input);
40 
41 void
42 neural_layer_lstm_backward(const struct Layer *l, const struct Net *net,
43  const double *input, double *delta);
44 
45 void
46 neural_layer_lstm_update(const struct Layer *l);
47 
48 void
49 neural_layer_lstm_print(const struct Layer *l, const bool print_weights);
50 
51 bool
52 neural_layer_lstm_mutate(struct Layer *l);
53 
54 void
55 neural_layer_lstm_free(const struct Layer *l);
56 
57 double *
58 neural_layer_lstm_output(const struct Layer *l);
59 
60 size_t
61 neural_layer_lstm_save(const struct Layer *l, FILE *fp);
62 
63 size_t
64 neural_layer_lstm_load(struct Layer *l, FILE *fp);
65 
66 void
67 neural_layer_lstm_resize(struct Layer *l, const struct Layer *prev);
68 
69 char *
70 neural_layer_lstm_json_export(const struct Layer *l, const bool return_weights);
71 
75 static struct LayerVtbl const layer_lstm_vtbl = {
76  &neural_layer_lstm_init, &neural_layer_lstm_mutate,
77  &neural_layer_lstm_resize, &neural_layer_lstm_copy,
78  &neural_layer_lstm_free, &neural_layer_lstm_rand,
79  &neural_layer_lstm_print, &neural_layer_lstm_update,
80  &neural_layer_lstm_backward, &neural_layer_lstm_forward,
81  &neural_layer_lstm_output, &neural_layer_lstm_save,
82  &neural_layer_lstm_load, &neural_layer_lstm_json_export
83 };
neural_layer.h
Interface for neural network layers.
neural_layer_lstm_backward
void neural_layer_lstm_backward(const struct Layer *l, const struct Net *net, const double *input, double *delta)
Backward propagates an LSTM layer.
Definition: neural_layer_lstm.c:461
neural_layer_lstm_rand
void neural_layer_lstm_rand(struct Layer *l)
Randomises an LSTM layer weights.
Definition: neural_layer_lstm.c:400
neural_layer_lstm_mutate
bool neural_layer_lstm_mutate(struct Layer *l)
Mutates an LSTM layer.
Definition: neural_layer_lstm.c:561
neural_layer_lstm_output
double * neural_layer_lstm_output(const struct Layer *l)
Returns the output from an LSTM layer.
Definition: neural_layer_lstm.c:550
neural_layer_lstm_free
void neural_layer_lstm_free(const struct Layer *l)
Free memory used by an LSTM layer.
Definition: neural_layer_lstm.c:373
neural_layer_lstm_copy
struct Layer * neural_layer_lstm_copy(const struct Layer *src)
Initialises and creates a copy of one LSTM layer from another.
Definition: neural_layer_lstm.c:327
neural_layer_lstm_load
size_t neural_layer_lstm_load(struct Layer *l, FILE *fp)
Reads an LSTM layer from a file.
Definition: neural_layer_lstm.c:709
layer_lstm_vtbl
static struct LayerVtbl const layer_lstm_vtbl
Neural long short-term memory layer implemented functions.
Definition: neural_layer_lstm.h:75
neural_layer_lstm_resize
void neural_layer_lstm_resize(struct Layer *l, const struct Layer *prev)
Resizes an LSTM layer if the previous layer has changed size.
Definition: neural_layer_lstm.c:531
neural_layer_lstm_print
void neural_layer_lstm_print(const struct Layer *l, const bool print_weights)
Prints an LSTM layer.
Definition: neural_layer_lstm.c:590
neural_layer_lstm_save
size_t neural_layer_lstm_save(const struct Layer *l, FILE *fp)
Writes an LSTM layer to a file.
Definition: neural_layer_lstm.c:662
neural_layer_lstm_update
void neural_layer_lstm_update(const struct Layer *l)
Updates the weights and biases of an LSTM layer.
Definition: neural_layer_lstm.c:511
neural_layer_lstm_json_export
char * neural_layer_lstm_json_export(const struct Layer *l, const bool return_weights)
Returns a json formatted string representation of an LSTM layer.
Definition: neural_layer_lstm.c:605
neural_layer_lstm_init
void neural_layer_lstm_init(struct Layer *l, const struct ArgsLayer *args)
Initialises a long short-term memory layer.
Definition: neural_layer_lstm.c:284
neural_layer_lstm_forward
void neural_layer_lstm_forward(const struct Layer *l, const struct Net *net, const double *input)
Forward propagates an LSTM layer.
Definition: neural_layer_lstm.c:419
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