BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
DistributionTrapezoid Class Reference

Trapezoidal distribution. More...

+ Inheritance diagram for DistributionTrapezoid:

Public Member Functions

 DistributionTrapezoid (const std::vector< double > P)
 
 DistributionTrapezoid (double center, double left, double middle, double right)
 
DistributionTrapezoidclone () const final
 
double probabilityDensity (double x) const final
 Returns the distribution-specific probability density for value x.
 
double getMean () const final
 Returns the distribution-specific mean.
 
double getLeftWidth () const
 
double getMiddleWidth () const
 
double getRightWidth () const
 
virtual std::vector< double > equidistantPoints (size_t nbr_samples, double sigma_factor, const RealLimits &limits=RealLimits()) const
 generate list of sample values
 
bool isDelta () const final
 Returns true if the distribution is in the limit case of a Dirac delta distribution.
 
void accept (INodeVisitor *visitor) const final
 Calls the INodeVisitor's visit method.
 
- Public Member Functions inherited from IDistribution1D
 IDistribution1D (const NodeMeta &meta, const std::vector< double > &PValues)
 
std::vector< ParameterSampleequidistantSamples (size_t nbr_samples, double sigma_factor=0., const RealLimits &limits=RealLimits()) const
 Returns equidistant samples, using intrinsic parameters, weighted with probabilityDensity().
 
std::vector< ParameterSampleequidistantSamplesInRange (size_t nbr_samples, double xmin, double xmax) const
 Returns equidistant samples from xmin to xmax, weighted with probabilityDensity().
 
virtual std::vector< double > equidistantPointsInRange (size_t nbr_samples, double xmin, double xmax) const
 Returns equidistant interpolation points from xmin to xmax.
 
virtual void setUnits (const std::string &units)
 Sets distribution units.
 
- Public Member Functions inherited from ICloneable
 ICloneable (const ICloneable &)=delete
 
 ICloneable (ICloneable &&)=default
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py)
 
- Public Member Functions inherited from INode
 INode (const NodeMeta &meta, const std::vector< double > &PValues)
 
virtual std::string treeToString () const
 Returns multiline string representing tree structure below the node.
 
void registerChild (INode *node)
 
virtual std::vector< const INode * > getChildren () const
 Returns a vector of children (const).
 
virtual void setParent (const INode *newParent)
 
const INodeparent () const
 
INodeparent ()
 
int copyNumber (const INode *node) const
 Returns copyNumber of child, which takes into account existence of children with same name.
 
std::string displayName () const
 Returns display name, composed from the name of node and it's copy number.
 
ParameterPoolcreateParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
- Public Member Functions inherited from IParameterized
 IParameterized (const std::string &name="")
 
 IParameterized (const IParameterized &other)
 
IParameterizedoperator= (const IParameterized &other)=delete
 
ParameterPoolparameterPool () const
 Returns pointer to the parameter pool.
 
std::string parametersToString () const
 Returns multiline string representing available parameters.
 
RealParameterregisterParameter (const std::string &name, double *parpointer)
 
void registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
 
void setParameterValue (const std::string &name, double value)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
RealParameterparameter (const std::string &name) const
 Returns parameter with given 'name'.
 
virtual void onChange ()
 Action to be taken in inherited class when a parameter has changed.
 
void removeParameter (const std::string &name)
 
void removeVector (const std::string &base_name)
 
void setName (const std::string &name)
 
const std::string & getName () const
 

Additional Inherited Members

- Static Public Member Functions inherited from IParameterized
static std::string XComponentName (const std::string &base_name)
 
static std::string YComponentName (const std::string &base_name)
 
static std::string ZComponentName (const std::string &base_name)
 
- Protected Member Functions inherited from IDistribution1D
void adjustMinMaxForLimits (double &xmin, double &xmax, const RealLimits &limits) const
 modifies xmin and xmax if they are outside of limits
 
std::vector< ParameterSamplegenerateSamplesFromValues (const std::vector< double > &sample_values) const
 Returns weighted samples from given interpolation points and probabilityDensity().
 
- Protected Attributes inherited from INode
const size_t m_NP
 
std::vector< double > m_P
 

Detailed Description

Trapezoidal distribution.

Definition at line 260 of file Distributions.h.


The documentation for this class was generated from the following files: