Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrd >> jelly >> [ random overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mrd.jelly.random
Class Beta  

java.lang.Object
  org.apache.commons.jelly.TagSupport
      org.mrd.jelly.random.DistributionTagBase
          org.mrd.jelly.random.Beta

All Implemented Interfaces:

org.apache.commons.jelly.Tag

---

public class Beta

extends DistributionTagBase

This is a random number generation class that produces pseudo-random doubles acording to a configured Beta Distribution. The Distribution is supported by the cern.jet.random.Beta Distribution Class. The distribution can be configured by two strategies 1.) Alpha and Beta parameters can be provided for the distribution. 2.) The mean and standard devation can be provided to configure the distribution. With this strategy alpha and beta are estimated through the equations: alpha = mean{[mean(1-mean)/s^2] - 1} beta = (1-mean) mean{[mean(1-mean)/s^2] - 1}

---

Field Summary
private  double	alpha           Holds value of property alpha.
private  double	beta           Holds value of property beta.
private  boolean	limitVariance           Holds value of property limitVariance.
private  double	mean           Holds value of property mean.
private  boolean	setByMean
private  double	std           Holds value of property std.

 

Fields inherited from class org.mrd.jelly.random.DistributionTagBase

 

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, hasTrimmed, parent, shouldTrim

 

Constructor Summary

Beta()

 

Method Summary
void	doStartTag(org.apache.commons.jelly.XMLOutput xMLOutput)           Used by Ant to check if the appropriate attributes have been filled out.
double	getAlpha()           Getter for property alpha.
double	getBeta()           Getter for property beta.
double	getMean()           Getter for property mean.
double	getStd()           Getter for property std.
boolean	isLimitVariance()           Getter for property limitVariance.
void	setAlpha(double alpha)           If used Beta is configured by alpha and beta is also required.
void	setBeta(double beta)           If used Beta is configured by beta and alpha is also required.
void	setLimitVariance(boolean limitVariance)           Available when Beta is configured by Mean and Std.
void	setMean(double mean)           If used Beta is configured byMean and std is also required.
void	setStd(double std)           If used Beta is configured byMean and mean is also required.

 

Methods inherited from class org.mrd.jelly.random.DistributionTagBase

doBody, doEndTag, doTag, getEngine, getRandomElement, getVar, setEngine, setVar

 

Methods inherited from class org.apache.commons.jelly.TagSupport

findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

mean

private double mean

Holds value of property mean.

---

std

private double std

Holds value of property std.

---

alpha

private double alpha

Holds value of property alpha.

---

beta

private double beta

Holds value of property beta.

---

setByMean

private boolean setByMean

---

limitVariance

private boolean limitVariance

Holds value of property limitVariance.

Constructor Detail

Beta

public Beta()

Method Detail

doStartTag

public void doStartTag(org.apache.commons.jelly.XMLOutput xMLOutput)
                throws org.apache.commons.jelly.MissingAttributeException,
                       org.apache.commons.jelly.JellyTagException

Used by Ant to check if the appropriate attributes have been filled out.

Overrides:

doStartTag in class DistributionTagBase

---

getMean

public double getMean()

Getter for property mean.

---

setMean

public void setMean(double mean)

If used Beta is configured byMean and std is also required. Otherwise, alpha and beta are required.

---

getStd

public double getStd()

Getter for property std.

---

setStd

public void setStd(double std)

If used Beta is configured byMean and mean is also required. Otherwise, alpha and beta are required.

---

getAlpha

public double getAlpha()

Getter for property alpha.

---

setAlpha

public void setAlpha(double alpha)

If used Beta is configured by alpha and beta is also required. Otherwise, mean and std are required.

---

getBeta

public double getBeta()

Getter for property beta.

---

setBeta

public void setBeta(double beta)

If used Beta is configured by beta and alpha is also required. Otherwise, mean and std are required.

---

isLimitVariance

public boolean isLimitVariance()

Getter for property limitVariance.

---

setLimitVariance

public void setLimitVariance(boolean limitVariance)

Available when Beta is configured by Mean and Std. Limits the variance acording to the behavior defined in the LimitedBeta Class. Optional.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrd >> jelly >> [ random overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---