nb_freq.h

Go to the documentation of this file.

/*
 * This work is licensed under a Creative Commons 
 * Attribution-Noncommercial-Share Alike 3.0 United States License.
 * 
 *    http://creativecommons.org/licenses/by-nc-sa/3.0/us/
 * 
 * You are free:
 * 
 *    to Share - to copy, distribute, display, and perform the work
 *    to Remix - to make derivative works
 * 
 * Under the following conditions:
 * 
 *    Attribution. You must attribute the work in the manner specified by the
 *    author or licensor (but not in any way that suggests that they endorse you
 *    or your use of the work).
 * 
 *    Noncommercial. You may not use this work for commercial purposes.
 * 
 *    Share Alike. If you alter, transform, or build upon this work, you may
 *    distribute the resulting work only under the same or similar license to
 *    this one.
 * 
 * For any reuse or distribution, you must make clear to others the license
 * terms of this work. The best way to do this is by including this header.
 * 
 * Any of the above conditions can be waived if you get permission from the
 * copyright holder.
 * 
 * Apart from the remix rights granted under this license, nothing in this
 * license impairs or restricts the author's moral rights.
 */


#ifndef NB_FREQ_H
#define NB_FREQ_H


#include <config.h>

#include <stdlib.h>
#include <inttypes.h>

#include <jwsc/base/error.h>
#include <jwsc/vector/vector.h>
#include <jwsc/matrix/matrix.h>


typedef struct
{
    uint32_t  num_markers;

    uint32_t  min_marker_val;

    uint32_t  num_marker_vals;

    Matrix_d* marker_given_label;

    Vector_d* priors;
} 
NB_freq_model;


void train_nb_freq_model
(
    NB_freq_model**   model_out,
    const Vector_u32* labels, 
    const Matrix_i32* markers,
    const Vector_d*   priors
);


Error* predict_label_with_nb_freq_model
(
    uint32_t*            label_out,
    double*              confidence_out,
    const Vector_i32*    markers,
    const NB_freq_model* model,
    uint32_t             order
);


Error* predict_labels_with_nb_freq_model
(
    Vector_u32**         labels_out,
    Vector_d**           confidence_out,
    const Matrix_i32*    markers,
    const NB_freq_model* model
);


Error* read_nb_freq_model(NB_freq_model** model_out, const char* fname);


Error* write_nb_freq_model(NB_freq_model* model, const char* fname);


void free_nb_freq_model(NB_freq_model* model);


typedef struct NB_freq_model_node
{
    const struct NB_freq_model_node* parent;

    uint32_t parent_label;

    uint32_t num_groups;

    struct NB_freq_model_node** subtrees;

    Vector_u32* labels;

    Vector_u32** altlabels;

    Vector_d* priors;

    NB_freq_model* model;

    char* model_fname;
} 
NB_freq_model_node;


typedef  NB_freq_model_node  NB_freq_model_tree;


Error* train_nb_freq_model_tree
(
    NB_freq_model_tree** tree_out,
    const Vector_u32*    labels, 
    const Matrix_i32*    markers,
    const char*          tree_xml_fname,
    const char*          tree_dtd_fname
);


Error* predict_labels_with_nb_freq_model_tree
(
    Vector_u32**              labels_out,
    Vector_d**                confidence_out,
    const Matrix_i32*         markers,
    const NB_freq_model_tree* tree,
    uint32_t                  order
);


Error* read_nb_freq_model_tree
(
    NB_freq_model_tree** tree_out,
    const char*          tree_xml_fname,
    const char*          tree_dtd_fname,
    const char*          model_dirname
);


Error* write_nb_freq_model_tree
(
    const NB_freq_model_tree* tree,
    const char*               model_dirname
);


void free_nb_freq_model_tree(NB_freq_model_tree* tree);


#endif