// Copyright (C) 2003 Ronan Collobert (collober@idiap.ch)
//                
// This file is part of Torch 3.
//
// 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.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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.

#ifndef MULTI_CLASS_FORMAT_INC
#define MULTI_CLASS_FORMAT_INC

#include "ClassFormat.h"
#include "DataSet.h"

namespace Torch {

/** Define the multi class encoding format.
    Each class is coded by a single number.

    @author Ronan Collobert (collober@idiap.ch)
*/
class MultiClassFormat : public ClassFormat
{
  public:

    /// Array of class labels.
    real *tabclasses;

    /// Autodetect classes.
    MultiClassFormat(DataSet *data);

    /// By default (if #class_labels_# is not specified), class labels are 0, 1, ...
    MultiClassFormat(int n_classes_, real *class_labels_=NULL);

    virtual int getClass(real *vector);
    virtual int getOutputSize();
    virtual void fromOneHot(real *outputs, real *one_hot_outputs);
    virtual void toOneHot(real *outputs, real *one_hot_outputs);

    virtual ~MultiClassFormat();
};


}

#endif