PDistribution.h

Go to the documentation of this file.

// -*- C++ -*-

// PDistribution.h
//
// Copyright (C) 2003  Pascal Vincent 
// 
// 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 authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

/* *******************************************************      
   * $Id: PDistribution.h,v 1.17 2004/07/21 20:24:07 tihocan Exp $ 
   ******************************************************* */

#ifndef PDistribution_INC
#define PDistribution_INC

#include <plearn_learners/generic/PLearner.h>

namespace PLearn {
using namespace std;

class PDistribution: public PLearner
{

private:

  typedef PLearner inherited;

  mutable Vec store_expect, store_result;
  mutable Mat store_cov;

protected:

  // *********************
  // * protected options *
  // *********************

  TVec<int> cond_sort;
  int n_input;
  int n_margin;
  int n_target;

  // Fields below are not options.

  bool already_sorted;

  TVec<int> cond_swap;

  real delta_curve;

  bool full_joint_distribution;

  mutable Vec input_part;       
  mutable Vec target_part;      

  mutable bool need_set_input;

public:

  // ************************
  // * public build options *
  // ************************

  TVec<int> conditional_flags;
  real lower_bound, upper_bound; 
  int n_curve_points;
  string outputs_def;
  Vec provide_input;

  // ****************
  // * Constructors *
  // ****************

  PDistribution();

  // ********************
  // * PLearner methods *
  // ********************

private: 

  void build_();

protected: 

  static void declareOptions(OptionList& ol);

public:

  // ************************
  // **** Object methods ****
  // ************************

  virtual void build();

  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

  // Declares other standard object methods
  PLEARN_DECLARE_OBJECT(PDistribution);

  // **************************
  // **** PLearner methods ****
  // **************************

  virtual int outputsize() const;

  virtual void forget();

  virtual void train();

  virtual void computeOutput(const Vec& input, Vec& output) const;

  virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
                                       const Vec& target, Vec& costs) const;

  // *******************************
  // **** PDistribution methods ****
  // *******************************

private:

  void setConditionalFlagsWithoutUpdate(TVec<int>& flags);

protected:

  bool ensureFullJointDistribution(TVec<int>& old_flags);

  void finishConditionalBuild();

  void resizeParts();

  void sortFromFlags(Vec& v);
  void sortFromFlags(Mat& m, bool sort_columns = true, bool sort_rows = false);

  bool splitCond(const Vec& input) const;
  
  virtual void updateFromConditionalSorting();

public:

  void setConditionalFlags(TVec<int>& flags);

  virtual void setInput(const Vec& input) const;

  virtual void setTrainingSet(VMat training_set, bool call_forget=true);

  virtual TVec<string> getTestCostNames() const;

  virtual TVec<string> getTrainCostNames() const;

  virtual real log_density(const Vec& y) const;

  virtual real density(const Vec& y) const;
  
  virtual real survival_fn(const Vec& y) const;

  virtual real cdf(const Vec& y) const;

  virtual void expectation(Vec& mu) const;

  virtual void variance(Mat& cov) const;

  virtual void resetGenerator(long g_seed) const;
  
  virtual void generate(Vec& y) const;

  void generateN(const Mat& Y) const;

};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(PDistribution);
  
} // end of namespace PLearn

#endif

---