/home/rex/ebltrunk/tools/libeblearntools/include/netconf.h

/***************************************************************************
 *   Copyright (C) 2010 by Pierre Sermanet *
 *   pierre.sermanet@gmail.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:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Redistribution under a license not approved by the Open Source
 *       Initiative (http://www.opensource.org) must display the
 *       following acknowledgement in all advertising material:
 *        This product includes software developed at the Courant
 *        Institute of Mathematical Sciences (http://cims.nyu.edu).
 *     * The names of the authors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``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 AUTHORS 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 NETCONF_H_
#define NETCONF_H_

#include "libeblearn.h"
#include "configuration.h"
#include "tools_utils.h"

namespace ebl {

  // TODO: default is not allowed for function template,
  // solution is to use -std=c++0x or -std=gnu++0x but not available everywhere
  // -> find test for these capabilities in cmake
  template <typename T, class Tstate>
    module_1_1<T,Tstate>*
    create_network(parameter<T, Tstate> &theparam, configuration &conf,
                   intg &thick, int noutputs = -1, const char *varname = "arch",
                   bool isbranch = false, bool narrow = 0,
                   intg narrow_dim = 0, intg narrow_size = 0,
                   intg narrow_offset = 0,
                   vector<layers<T,Tstate>*>* branches = NULL,
                   vector<intg> *branches_thick = NULL,
                   map<string,module_1_1<T,Tstate>*> *shared = NULL);


  template <typename T, class Tstate>
    module_1_1<T,Tstate>*
    create_module(const string &name, parameter<T, Tstate> &theparam,
                  configuration &conf, int &nout, intg &thick,
                  map<string,module_1_1<T,Tstate>*> &shared,
                  vector<layers<T,Tstate>*> *branches,
                  vector<intg> *branches_thick);

  template <typename T, class Tstate>
    ebm_1<T,Tstate>* create_ebm1(const string &name, configuration &conf);

  template <typename T, typename Tds1, typename Tds2, class Tstate>
    answer_module<T,Tds1,Tds2,Tstate>*
    create_answer(configuration &conf, uint nclasses,
                  const char *varname = "answer");

  template <typename T, typename Tds1, typename Tds2, class Tstate>
    trainable_module<T,Tds1,Tds2,Tstate>*
    create_trainer(configuration &conf, labeled_datasource<T,Tds1,Tds2> &ds,
                   module_1_1<T,Tstate> &net,
                   answer_module<T,Tds1,Tds2,Tstate> &answer,
                   const char *varname = "trainer");

  // preprocessing /////////////////////////////////////////////////////////////

  template <typename T, class Tstate>
    resizepp_module<T,Tstate>* 
    create_preprocessing(uint height, uint width, const char *ppchan,
                         idxdim &kersz, const char *resize_method = "bilinear",
                         bool keep_aspect_ratio = true, int lpyramid = 0,
                         vector<double> *fovea = NULL, 
                         midxdim *fovea_scale_size = NULL, 
                         bool globnorm = true,
                         bool locnorm = false, bool locnorm2 = false,
                         bool color_lnorm = false, bool cnorm_across = true,
                         double hscale = 1.0, double wscale = 1.0,
                         vector<float> *scalings = NULL);
  
  template <typename T, class Tstate>
    resizepp_module<T,Tstate>* 
    create_preprocessing(midxdim &dims, const char *ppchan,
                         midxdim &kersz, midxdim &zpads,
                         const char *resize_method = "bilinear", 
                         bool keep_aspect_ratio = true, int lpyramid = 0,
                         vector<double> *fovea = NULL, 
                         midxdim *fovea_scale_size = NULL, 
                         bool globnorm = true,
                         bool locnorm = false, bool locnorm2 = false,
                         bool color_lnorm = false, bool cnorm_across = true,
                         double hscale = 1.0, double wscale = 1.0,
                         vector<float> *scalings = NULL);
  
  template <typename T, class Tstate>
    resizepp_module<T,Tstate>* 
    create_preprocessing(const char *ppchan, midxdim &kersz, midxdim &zpads,
                         const char *resize_method = "bilinear",
                         bool keep_aspect_ratio = true, int lpyramid = 0,
                         vector<double> *fovea = NULL, 
                         midxdim *fovea_scale_size = NULL, 
                         bool globnorm = true,
                         bool locnorm = false, bool locnorm2 = false,
                         bool color_lnorm = false, bool cnorm_across = true,
                         double hscale = 1.0, double wscale = 1.0,
                         vector<float> *scalings = NULL);

  
  // TODO: default is not allowed for function template,
  // solution is to use -std=c++0x or -std=gnu++0x but not available everywhere
  // -> find test for these capabilities in cmake
  template <typename T, class Tstate> // = bbstate_idx<T> >
    module_1_1<T,Tstate>* create_network_old(parameter<T, Tstate> &theparam,
                                             configuration &conf,
                                             int noutputs = -1);
  
  template <class Tmodule, typename T, class Tstate>
    bool load_module(configuration &conf, module_1_1<T,Tstate> &m,
                     const string &module_name, const string &type);

  template <typename T, class Tstate>
    uint manually_load_network(layers<T,Tstate> &l, configuration &conf, 
                               const char *varname = "arch");
  
  bool EXPORT load_table(configuration &conf, const string &module_name,
                         idx<intg> &table, intg thickness, intg noutputs);

  void EXPORT load_gd_param(configuration &conf, gd_param &gdp);
    
} // end namespace ebl

#include "netconf.hpp"

#endif /* NETCONF_H_ */