Mlp.core.h

Go to the documentation of this file.

#ifndef ae2f_Ann_Mlp_core_h
#define ae2f_Ann_Mlp_core_h
 
#include <ae2f/Call.h>
#include <ae2f/Cast.h>
 
#include <ae2f/Pack/Beg.h>
#include "./Act.h"
 
ae2f_structdef(struct, ae2f_AnnMlp);
 
/**
 * @brief
 * # Multi Layered Perceptron
 *
 * This is a data-only structure, used for type-punning.
 */
ae2f_structdef(struct, ae2f_AnnMlp_t)
{
    /**
     * @brief
     * Depth of the network, including input and output layers.
     */
    size_t  m_depth;
 
    /**
     * @brief
     * Possible greatest output size.
     */
    size_t  m_outc;
};
 
/**
 * @brief
 * Structure used for MLP prediction.
 */
ae2f_structdef_n(struct, ae2f_AnnMlpPredict_t, ae2f_AnnMlpPredictStream_t) {
    /**
     * @brief
     * Input, output, and loop counters.
     */
    size_t      m_inc, m_outc, m_i, m_j, m_k, m_depth, m_outc_max;
 
    /**
     * @brief
     * Return value.
     */
    ae2f_float_t    m_ret, m_tmp;
};
 
/**
 * @brief
 * A union for type-punning pointers during MLP initialization.
 * This allows treating a block of memory as different pointer types.
 */
ae2f_structdef(union, ae2f_AnnMlpInitMkPtr_t) {
    /**
     * @brief
     * Pointer to an MLP structure.
     */
    ae2f_AnnMlp* restrict   m_mlp;
    /**
     * @brief
     * Pointer to a size_t array.
     */
    size_t* restrict    m_sz;
    /**
     * @brief
     * Pointer to a float array.
     */
    ae2f_float_t* restrict  m_f;
    /**
     * @brief
     * Generic void pointer.
     */
    void* restrict      m_void;
    /**
     * @brief
     * Generic pointer to a pointer.
     */
    void** restrict     m_ptr;
    /**
     * @brief
     * Pointer to an array of activation functions.
     */
    ae2f_AnnAct_t** restrict    m_Act;
    /**
     * @brief
     * Pointer to an array of loss functions.
     */
    ae2f_AnnLoss_t** restrict   m_Loss;
 
    /** for 1-byte padding */
    char* restrict      m_byte;
};
 
/**
 * @brief
 * Structure for MLP initialization data.
 */
ae2f_structdef(struct, ae2f_AnnMlpInit_t) {
    /**
     * @brief
     * Maximum output count among all layers.
     */
    size_t m_outc;
    /**
     * @brief
     * Loop counter.
     */
    size_t m_i;
};
 
/**
 * @brief
 * Structure for MLP creation data.
 */
ae2f_structdef(struct, ae2f_AnnMlpMk_t) {
    /**
     * @brief
     * Maximum output count among all layers.
     */
    size_t m_outc;
    /**
     * @brief
     * Loop counter.
     */
    size_t m_i;
    /**
     * @brief
     * Union for pointer manipulation during creation.
     */
    ae2f_AnnMlpInitMkPtr_t  m_mkptr;
    /**
     * @brief
     * Base pointer to the created MLP.
     */
    ae2f_AnnMlp* restrict   m_mkbase;
};
 
/**
 * @brief
 * Structure for calculating a single hidden delta value.
 */
ae2f_structdef(struct, ae2f_AnnMlpHidDeltaSingle_t) {
    /** 
     * @brief delta seed, not delta.
     * Use __ae2f_AnnPropagate to make delta.
     * */
    ae2f_float_t    m_ret;
    /**
     * @brief
     * Output count of the layer.
     */
    size_t      m_outc;
    /**
     * @brief
     * Loop counter.
     */
    size_t      m_i;
};
 
/**
 * @brief
 * Stack data for backpropagation.
 * @deprecated This is deprecated.
 */
ae2f_structdef_n(union, ae2f_AnnMlpPropagateAllStack_t, ae2f_AnnMlpFollowStack_t) {
    size_t m_send;
};
 
/**
 * @brief
 * Structure for backpropagation through all layers.
 * @deprecated This is deprecated.
 */
ae2f_structdef_n(struct, ae2f_AnnMlpPropagateAll_t, ae2f_AnnMlpFollow_t) {
    /**
     * @brief
     * Loop counters and layer sizes.
     */
    size_t              m_i, m_j, m_inc, m_outc;
    /**
     * @brief
     * Layer index.
     */
    size_t              m_k;
    /**
     * @brief
     * Page size for weights.
     */
    size_t              m_pg_weight;
    /**
     * @brief
     * Page size for outputs.
     */
    size_t              m_pg_out;
    /**
     * @brief
     * Stack for propagation.
     */
    ae2f_AnnMlpPropagateAllStack_t  m_stack;
    /**
     * @brief
     * Return value.
     */
    ae2f_float_t                m_ret;
};
 
/**
 * @brief
 * Structure for MLP training data.
 */
ae2f_structdef(struct, ae2f_AnnMlpTrain_t) {
    /**
     * @brief
     * Loop counters and layer sizes.
     */
    size_t              m_i, m_j, m_inc, m_outc;
    /**
     * @brief
     * Layer index.
     */
    size_t              m_k;
    /**
     * @brief
     * Page size for weights.
     */
    size_t              m_pg_weight;
    /**
     * @brief
     * Page size for outputs.
     */
    size_t              m_pg_out;
    /**
     * @brief
     * Maximum output size.
     */
    size_t              m_outc_max;
    /**
     * @brief
     * Network depth.
     */
    size_t              m_depth;
 
    /**
     * @brief
     * Stack for propagation.
     */
    ae2f_AnnMlpPropagateAllStack_t  m_stack;
    /**
     * @brief
     * Return value.
     */
    ae2f_float_t                m_ret, m_tmp, m_tmp1;
};
 
#include <ae2f/Pack/End.h>
 
#endif