---

nn.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2002, 2003 Allan Saddi <allan@saddi.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY ALLAN SADDI AND HIS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL ALLAN SADDI OR HIS CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: nn.h 325 2003-02-22 11:39:21Z asaddi $
 */

#ifndef _APS_NN_H
#define _APS_NN_H

#include <stdio.h>

struct _nnNode;

typedef struct _nnLink {
  struct _nnNode *source; 
  double w, 
    del_w; 
} nnLink;

typedef struct _nnNode {
  unsigned long id; 
  double a; 
  double in; 
  double err; 
  double del; 
  int nlinks; 
  nnLink *links; 
} nnNode;

typedef struct _nnLayer {
  int nnodes; 
  nnNode *nodes; 
} nnLayer;

typedef struct _nnNet {
  double LearningRate; 
  double Momentum; 
  double (*ActivationF) (nnNode *node); 
  double (*dActivationF) (nnNode *node); 
  nnNode *biasNode; 
  int nlayers; 
  nnLayer *layers; 
} nnNet;

typedef enum _nnFileType {
  nnFileTypeUnknown, 
  nnFileTypeBinary, 
  nnFileTypeXML 
} nnFileType;

static inline nnLayer *
nnGetNetworkOutputLayer (nnNet *net)
{
  return &net->layers[0];
}

static inline nnLayer *
nnGetNetworkInputLayer (nnNet *net)
{
  return &net->layers[net->nlayers - 1];
}

/* Core */
double nnSigmoid (nnNode *node);
double nnDSigmoid (nnNode *node);
void nnRunNetwork (nnNet *net);
void nnSetNetworkInputs (nnNet *net, const double inputs[]);
void nnGetNetworkOutputs (nnNet *net, double outputs[]);

/* Back-propagation */
void nnCalculateOutputLayerError (nnLayer *layer, const double targets[]);
void nnCalculateHiddenLayerError (nnLayer *layer, nnLayer *nextLayer);
void nnUpdateLayer (nnLayer *layer, nnNet *net);
void nnUpdateNetwork (nnNet *net, const double targets[]);

/* Batch-update back-propagation */
void nnUpdateLayerBatch (nnLayer *layer, nnNet *net);
void nnUpdateNetworkBatch (nnNet *net, double const targets[]);
void nnClearNetworkWeightDeltas (nnNet *net);
void nnUpdateNetworkWeights (nnNet *net);

/* Network loading/saving */
int nnSaveNetwork (nnNet *net, void *handle,
                   int (*nnWrite) (void *handle, void *data, size_t len));
int nnSaveNetworkFile (nnNet *net, FILE *f);
int nnSaveNetworkMem (nnNet *net, void *data, size_t len);
int nnSaveNetworkDynMem (nnNet *net, void **ptr, size_t *len);
nnNet *nnLoadNetwork (void *handle,
                      int (*nnRead) (void *handle, void *data, size_t len));
nnNet *nnLoadNetworkFile (FILE *f);
nnNet *nnLoadNetworkMem (void *data, size_t len);
nnFileType nnGuessFileType (FILE *f);

/* Network loading/saving (XML) */
int nnSaveNetworkXML (nnNet *net, FILE *f);
nnNet *nnLoadNetworkXML (FILE *f);

/* Utility */
double nnGetLayerError (nnLayer *layer);
double nnGetLayerRMSError (nnLayer *layer);
void nnIterateNetworkNodes (nnNet *net,
                            void (*f) (nnLayer *layer, nnNode *node,
                                       void *data),
                            void *data);
void nnIterateNetworkLinks (nnNet *net,
                            void (*f) (nnNode *dest, nnLink *link,
                                       void *data),
                            void *data);
void nnDestroyNetwork (nnNet *net);
nnNet *nnCreateFullyConnectedNetwork (int nlayers, const int nnodes[]);
nnNet *nnCopyNetwork (nnNet *net);

#endif /* _APS_NN_H */

---