PLearn 0.1
SpiralDistribution.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // SpiralDistribution.h
00005 //
00006 // Copyright (C) 2003  Pascal Vincent
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 /* *******************************************************
00037  * $Id: SpiralDistribution.h 5388 2006-04-13 21:28:14Z lamblin $
00038  ******************************************************* */
00039 
00041 #ifndef SpiralDistribution_INC
00042 #define SpiralDistribution_INC
00043 
00044 #include "UnconditionalDistribution.h"
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 class SpiralDistribution: public UnconditionalDistribution
00050 {
00051 public:
00052 
00053     typedef UnconditionalDistribution inherited;
00054 
00055     // ************************
00056     // * public build options *
00057     // ************************
00058 
00059     // see implementation of and declareOptions() methods in .cc for description
00060     // of these options
00061     real lambda;
00062     real alpha;
00063     real tmin;
00064     real tmax;
00065     real sigma;
00066     real uniformity;
00067     bool include_t;
00068 
00069     // ****************
00070     // * Constructors *
00071     // ****************
00072 
00073     // Default constructor, make sure the implementation in the .cc
00074     // initializes all fields to reasonable default values.
00075     SpiralDistribution();
00076 
00077     // ******************
00078     // * PDistribution methods *
00079     // ******************
00080 
00081 private:
00083     // (Please implement in .cc)
00084     void build_();
00085 
00086 protected:
00088     // (Please implement in .cc)
00089     static void declareOptions(OptionList& ol);
00090 
00091 public:
00092 
00093     // ************************
00094     // **** Object methods ****
00095     // ************************
00096 
00098     virtual void build();
00099 
00101     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00102 
00103     // Declares other standard object methods
00104     //  If your class is not instantiatable (it has pure virtual methods)
00105     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00106     PLEARN_DECLARE_OBJECT(SpiralDistribution);
00107 
00108 
00109     // ** specific methods **
00111     void curve(real t, real& x, real& y) const;
00112 
00113     // **************************
00114     // **** PDistribution methods ****
00115     // **************************
00116 
00118     virtual real log_density(const Vec& x) const;
00119 
00121     virtual real survival_fn(const Vec& x) const;
00122 
00124     virtual real cdf(const Vec& x) const;
00125 
00127     virtual void expectation(Vec& mu) const;
00128 
00130     virtual void variance(Mat& cov) const;
00131 
00133     virtual void generate(Vec& x) const;
00134 
00135     // **************************
00136     // **** Learner methods ****
00137     // **************************
00138 
00140     virtual int inputsize() const;
00141 
00142 };
00143 
00144 // Declares a few other classes and functions related to this class
00145 DECLARE_OBJECT_PTR(SpiralDistribution);
00146 
00147 } // end of namespace PLearn
00148 
00149 #endif
00150 
00151 
00152 /*
00153   Local Variables:
00154   mode:c++
00155   c-basic-offset:4
00156   c-file-style:"stroustrup"
00157   c-file-offsets:((innamespace . 0)(inline-open . 0))
00158   indent-tabs-mode:nil
00159   fill-column:79
00160   End:
00161 */
00162 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines