Usage

`javascript
var Float64Results = require( '@stdlib/stats-base-ztest-two-sample-results-float64' );
`

#### Float64Results( \[arg\[, byteOffset\[, byteLength]]] )

Returns a two-sample Z-test double-precision floating-point results object.

`javascript
var results = new Float64Results();
// returns {...}
`

The function supports the following parameters:

- arg: an [ArrayBuffer][@stdlib/array/buffer] or a data object (_optional_).
- byteOffset: byte offset (_optional_).
- byteLength: maximum byte length (_optional_).

A data object argument is an object having one or more of the following properties:

- rejected: boolean indicating whether the null hypothesis was rejected.
- alternative: the alternative hypothesis (e.g., 'two-sided', 'less', or 'greater').
- alpha: significance level.
- pValue: p-value.
- statistic: test statistic.
- ci: confidence interval as a [Float64Array][@stdlib/array/float64].
- nullValue: difference in means under the null hypothesis.
- xmean: sample mean of x.
- ymean: sample mean of y.

#### Float64Results.prototype.rejected

Boolean indicating whether the null hypothesis was rejected.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.rejected;
// returns
`

#### Float64Results.prototype.alternative

The alternative hypothesis.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.alternative;
// returns
`

#### Float64Results.prototype.alpha

Significance level.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.alpha;
// returns
`

#### Float64Results.prototype.pValue

The test p-value.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.pValue;
// returns
`

#### Float64Results.prototype.statistic

The test statistic.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.statistic;
// returns
`

#### Float64Results.prototype.ci

Confidence interval.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.ci;
// returns
`

#### Float64Results.prototype.nullValue

Difference in means under the null hypothesis.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.nullValue;
// returns
`

#### Float64Results.prototype.xmean

Sample mean of x.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.xmean;
// returns
`

#### Float64Results.prototype.ymean

Sample mean of y.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.ymean;
// returns
`

#### Float64Results.prototype.toString( \[options] )

Serializes a results object to a formatted string.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.toString();
// returns
`

The method supports the following options:

- digits: number of digits to display after decimal points. Default: 4.
- decision: boolean indicating whether to show the test decision. Default: true.

Example output:

`text

Two-sample Z-test

Alternative hypothesis: True difference in means is less than 1.0

pValue: 0.0406
statistic: 9.9901
95% confidence interval: [9.7821, 10.4451]

Test Decision: Reject null in favor of alternative at 5% significance level

`

#### Float64Results.prototype.toJSON( \[options] )

Serializes a results object as a JSON object.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.toJSON();
// returns {...}
`

JSON.stringify() implicitly calls this method when stringifying a results instance.

#### Float64Results.prototype.toDataView()

Returns a [DataView][@stdlib/array/dataview] of a results object.

`javascript
var results = new Float64Results();
// returns {...}

// ...

var v = results.toDataView();
// returns
`