/* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
/* ====================================================================
 * Copyright (c) 2007 Carnegie Mellon University.  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 work was supported in part by funding from the Defense Advanced 
 * Research Projects Agency and the National Science Foundation of the 
 * United States of America, and the CMU Sphinx Speech Consortium.
 *
 * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND 
 * ANY EXPRESSED 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 CARNEGIE MELLON UNIVERSITY
 * NOR ITS EMPLOYEES 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.
 *
 * ====================================================================
 *
 */
/**
 * \file gau_mix.h
 * \author David Huggins-Daines <dhuggins@cs.cmu.edu>
 *
 * Gaussian mixtures (common functions)
 */

#ifndef __GAU_MIX_H__
#define __GAU_MIX_H__

#include <cmd_ln.h>
#include <gau_cb.h>


#ifdef __cplusplus
extern "C" {
#endif
#if 0
/* Fool Emacs. */
}
#endif

/**
 * Abstract type representing a set of Gaussian mixtures.
 **/
typedef struct gau_mix_s gau_mix_t;

/**
 * Read a set of Gaussian mixtures from a mixture weight file.
 **/
gau_mix_t *gau_mix_read(cmd_ln_t *config, const char *mixwfn);

/**
 * Retrieve the dimensionality and total number of elements in a set of mixtures.
 **/
size_t gau_mix_get_shape(gau_mix_t *mix, int *out_n_mixw,
                         int *out_n_feat, int *out_n_density,
                         int *out_is_transposed);

/**
 * Compute all mixture densities for a single feature stream
 * @return the index of the highest mixture density
 */
int gau_mix_compute_all(gau_mix_t *mix, gau_cb_t *cb, int *ts2cb, int32 *out_den);

/**
 * Compute a subset of mixture densities for a single feature stream
 * @return the index of the highest mixture density in active
 */
int gau_mix_compute(gau_mix_t *mix, gau_cb_t *cb, int *ts2cb,
                    int32 *active, int32 n_active, int32 *out_den);

/**
 * Release memory and/or file descriptors associated with Gaussian mixtures.
 **/
void gau_mix_free(gau_mix_t *mix);

#ifdef __cplusplus
}
#endif


#endif /* __GAU_MIX_H__ */