/home/rex/ebltrunk/core/libeblearn/include/ebl_merge.h

/***************************************************************************
 *   Copyright (C) 2011 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 EBL_MERGE_H_
#define EBL_MERGE_H_

#include "ebl_arch.h"
#include "ebl_march.h"

namespace ebl {

  // flat_merge ////////////////////////////////////////////////////////////////

  template <typename T, class Tstate> class zpad_module;

  template <typename T, class Tstate = bbstate_idx<T> >
    class flat_merge_module : public m2s_module<T, Tstate> {
  public:
    flat_merge_module(std::vector<Tstate**> &inputs,
                      idxdim &in, midxdim &ins,
                      fidxdim &stride, mfidxdim &strides,
                      const char *name_ = "flatmerge", const char *list = NULL);
    flat_merge_module(std::vector<mstate<Tstate>**> &inputs,
                      idxdim &in, midxdim &ins,
                      fidxdim &stride, mfidxdim &strides,
                      const char *name_ = "flatmerge", const char *list = NULL);
    flat_merge_module(midxdim &ins, mfidxdim &strides, bool pad = false,
                      const char *name_ = "flatmerge", mfidxdim *scales = NULL,
                      intg hextra = 0, intg wextra = 0, float ss = 1,
                      float edge = 0);
    virtual ~flat_merge_module();
    // generic states methods
    virtual void fprop(Tstate &in, Tstate &out);
    virtual void bprop(Tstate &in, Tstate &out);
    virtual void bbprop(Tstate &in, Tstate &out);
    // multi-states methods
    virtual void fprop(mstate<Tstate> &in, Tstate &out);
    virtual void bprop(mstate<Tstate> &in, Tstate &out);
    virtual void bbprop(mstate<Tstate> &in, Tstate &out);
    virtual idxdim fprop_size(idxdim &i_size);
    virtual fidxdim bprop_size(const fidxdim &o_size);
    virtual mfidxdim bprop_size(mfidxdim &osize);
    virtual std::string describe();
    virtual uint get_ninputs();
    virtual mfidxdim get_strides();
    virtual mfidxdim get_scales();
    virtual flat_merge_module<T,Tstate>* copy();
    /* //! Set paddings to be applied to each input scale. */
    /* virtual void set_paddings(mfidxdim &pads); */
    virtual void set_offsets(vector<vector<int> > &off);
    virtual void set_strides(mfidxdim &s);

  protected:
    idxdim compute_pad(idxdim &window, float subsampling, float edge,
                       float scale, fidxdim &stride);

  private:
    std::vector<Tstate**> inputs;
    idxdim din;
    midxdim dins;
    fidxdim stride;
    mfidxdim strides;
    std::string merge_list; 
    std::vector<zpad_module<T,Tstate>*> zpads;
    Tstate *in0;
    std::vector<Tstate*> pinputs;
    bool use_pinputs;
    mstate<Tstate> padded;
    zpad_module<T,Tstate> padder;
    bool bpad; 
    mfidxdim scales; 
    mfidxdim paddings; 
    vector<vector<int> > offsets; 

  // TEMP
  intg hextra, wextra;
  float subsampling, edge;
  };

  // mstate_merge //////////////////////////////////////////////////////////////

  template <typename T, class Tstate = bbstate_idx<T> >
    class mstate_merge_module : public module_1_1<T, Tstate> {
  public:
    mstate_merge_module(midxdim &ins, mfidxdim &strides,
                        const char *name_ = "mstate_merge");
    virtual ~mstate_merge_module();
    // multi-states methods ////////////////////////////////////////////////////
    virtual void fprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bbprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual idxdim fprop_size(idxdim &i_size);
    virtual fidxdim bprop_size(const fidxdim &o_size);
    virtual std::string describe();

  private:
    midxdim dins;
    mfidxdim dstrides;
  };

  // merge /////////////////////////////////////////////////////////////////////

  template <typename T, class Tstate = bbstate_idx<T> >
    class merge_module : public module_1_1<T, Tstate> {
  public:
    merge_module(std::vector<Tstate**> &inputs, intg concat_dim,
                 const char *name_ = "merge", const char *list = NULL);
    merge_module(std::vector<mstate<Tstate>**> &inputs, intg concat_dim,
                 const char *name_ = "merge", const char *list = NULL);
    merge_module(std::vector<std::vector<uint> > &states, intg concat_dim,
                 const char *name_ = "merge");
    virtual ~merge_module();
    virtual void fprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bbprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void fprop(Tstate &in, Tstate &out);
    virtual void bprop(Tstate &in, Tstate &out);
    virtual void bbprop(Tstate &in, Tstate &out);
    virtual std::string describe();

    // internal members ////////////////////////////////////////////////////////
  protected:
    virtual void merge(mstate<Tstate> &in, Tstate &out);

  private:
    std::vector<Tstate**> inputs;
    std::vector<mstate<Tstate>**> msinputs;
    std::string merge_list;
    std::vector<std::vector<uint> > states_list;
    intg concat_dim; 
  };

  // interlace /////////////////////////////////////////////////////////////////

  template <typename T, class Tstate = bbstate_idx<T> >
    class interlace_module : public module_1_1<T, Tstate> {
  public:
    interlace_module(uint stride, const char *name = "interlace_module");
    virtual ~interlace_module();
    virtual void fprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual void bbprop(mstate<Tstate> &in, mstate<Tstate> &out);
    virtual mfidxdim bprop_size(mfidxdim &osize);
    virtual std::string describe();
    virtual interlace_module<T,Tstate>* copy();
  private:
    uint stride; 
  };

} // namespace ebl {

#include "ebl_merge.hpp"

#endif /* EBL_MERGE_H_ */