SpiralDistribution.h

Go to the documentation of this file.

// -*- C++ -*-

// SpiralDistribution.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: SpiralDistribution.h,v 1.8 2004/06/26 00:24:15 plearner Exp $ 
   ******************************************************* */

#ifndef SpiralDistribution_INC
#define SpiralDistribution_INC

#include "UnconditionalDistribution.h"

namespace PLearn {
using namespace std;

class SpiralDistribution: public UnconditionalDistribution
{
public:

  typedef UnconditionalDistribution inherited;

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

  // see implementation of and declareOptions() methods in .cc for description
  // of these options
  real lambda;
  real alpha;
  real tmin;
  real tmax;
  real sigma;
  real uniformity;
  bool include_t;

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

  // Default constructor, make sure the implementation in the .cc
  // initializes all fields to reasonable default values.
  SpiralDistribution();

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

private: 
  // (Please implement in .cc)
  void build_();

protected: 
  // (Please implement in .cc)
  static void declareOptions(OptionList& ol);

public:

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

  virtual void build();

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

  // Declares other standard object methods
  //  If your class is not instantiatable (it has pure virtual methods)
  // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
  PLEARN_DECLARE_OBJECT(SpiralDistribution);

  
  // ** specific methods ** 
  void curve(real t, real& x, real& y) const;

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

  virtual real log_density(const Vec& x) const;

  virtual real survival_fn(const Vec& x) const;

  virtual real cdf(const Vec& x) const;

  virtual void expectation(Vec& mu) const;

  virtual void variance(Mat& cov) const;

  virtual void generate(Vec& x) const;
  
  // **************************
  // **** Learner methods ****
  // **************************

  virtual int inputsize() const;

  virtual void resetGenerator(long g_seed) const;

};

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

#endif

---