cauchy_distribution Class Reference

#include <cauchy.h>

Inheritance diagram for cauchy_distribution:

List of all members.

Public Member Functions
	cauchy_distribution (double location=1.0, double scale=1.0)
double	cdf (double x) const
double	inverse_cdf (double p) const
double	median () const
void	median (double m)
double	scale () const
void	scale (double s)

---

Detailed Description

The cauchy distribution.

References:

1. Eric W. Weisstein. "Cauchy Distribution." From MathWorld--A Wolfram Web Resource. http://mathworld.wolfram.com/CauchyDistribution.html

---

Constructor & Destructor Documentation

NUM_NAMESPACE_BEGIN cauchy_distribution::cauchy_distribution	(	double	m = 1.0,
		double	s = 1.0
	)

Create a distribution with the given location and scale values.

Parameters:

	location	the location parameter.
	scale	the scale parameter.

Create a distribution with the given location and scale values.

Parameters:

	m	the location parameter.
	s	the scale parameter.

---

Member Function Documentation

double cauchy_distribution::cdf

(

double

x

)

const [virtual]

The CDF for this distribution. This method returns P(X < x).

Parameters:

x

the value at which the CDF is evaluated.

Returns:

CDF for this distribution.

Implements continuous_distribution.

double cauchy_distribution::inverse_cdf

(

double

p

)

const [virtual]

The inverse CDF for this distribution. This method returns x such that, P(X < x) = p.

Parameters:

p

the cumulative probability.

Returns:

x

Implements continuous_distribution.

double cauchy_distribution::median

(

)

const

Access the location parameter.

Returns:

the location parameter.

void cauchy_distribution::median

(

double

m

)

Modify the location parameter.

Parameters:

m

the new location value.

double cauchy_distribution::scale

(

)

const

Access the scale parameter.

Returns:

the scale parameter.

void cauchy_distribution::scale

(

double

s

)

Modify the scale parameter.

Parameters:

s

the new scale value.

---

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

• src/main/cpp/numerics4cpp/statistics/distribution/cauchy.h
• src/main/cpp/numerics4cpp/statistics/distribution/cauchy.cpp

---