BoxSummary Class

The five-number summary of a sample, with its outliers, as a box plot draws it.

public sealed class BoxSummary : IEquatable<BoxSummary>
Implements

Constructors

NameDescription
BoxSummary(int, double, double, double, double, double, IReadOnlyList<double>)The five-number summary of a sample, with its outliers, as a box plot draws it.

BoxSummary(int, double, double, double, double, double, IReadOnlyList<double>)

BoxSummary.cs

The five-number summary of a sample, with its outliers, as a box plot draws it.

public BoxSummary(int Count, double LowerQuartile, double Median, double UpperQuartile, double LowerWhisker, double UpperWhisker, IReadOnlyList<double> Outliers)

Parameters

Count int
The number of values.
LowerQuartile double
The first quartile (25%).
Median double
The median (50%).
UpperQuartile double
The third quartile (75%).
LowerWhisker double
The smallest value that is not below BoxSummary.LowerQuartile minus 1.5 times the interquartile range.
UpperWhisker double
The largest value that is not above BoxSummary.UpperQuartile plus 1.5 times the interquartile range.
Outliers IReadOnlyList<double>
The values outside of the whiskers, in increasing order.

Properties

NameDescription
CountThe number of values.
LowerQuartileThe first quartile (25%).
LowerWhiskerThe smallest value that is not below BoxSummary.LowerQuartile minus 1.5 times the interquartile range.
MedianThe median (50%).
OutliersThe values outside of the whiskers, in increasing order.
UpperQuartileThe third quartile (75%).
UpperWhiskerThe largest value that is not above BoxSummary.UpperQuartile plus 1.5 times the interquartile range.

The number of values.

public int Count { get; init; }

Property value

int

LowerQuartile

BoxSummary.cs

The first quartile (25%).

public double LowerQuartile { get; init; }

Property value

double

LowerWhisker

BoxSummary.cs

The smallest value that is not below BoxSummary.LowerQuartile minus 1.5 times the interquartile range.

public double LowerWhisker { get; init; }

Property value

double

The median (50%).

public double Median { get; init; }

Property value

double

The values outside of the whiskers, in increasing order.

public IReadOnlyList<double> Outliers { get; init; }

Property value

IReadOnlyList<double>

UpperQuartile

BoxSummary.cs

The third quartile (75%).

public double UpperQuartile { get; init; }

Property value

double

UpperWhisker

BoxSummary.cs

The largest value that is not above BoxSummary.UpperQuartile plus 1.5 times the interquartile range.

public double UpperWhisker { get; init; }

Property value

double

Methods

NameDescription
Deconstruct(int, double, double, double, double, double, IReadOnlyList<double>)
Equals(BoxSummary?)
Equals(object?)
GetHashCode()
ToString()

Deconstruct(int, double, double, double, double, double, IReadOnlyList<double>)

public void Deconstruct(out int Count, out double LowerQuartile, out double Median, out double UpperQuartile, out double LowerWhisker, out double UpperWhisker, out IReadOnlyList<double> Outliers)

Parameters

Count int
LowerQuartile double
Median double
UpperQuartile double
LowerWhisker double
UpperWhisker double
Outliers IReadOnlyList<double>

No documentation is available.

Equals overloads

Equals(BoxSummary?)

public bool Equals(BoxSummary? other)
Parameters
other BoxSummary?
Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(BoxSummary?, BoxSummary?)
operator !=(BoxSummary?, BoxSummary?)

operator ==(BoxSummary?, BoxSummary?)

public static bool operator ==(BoxSummary? left, BoxSummary? right)

Parameters

left BoxSummary?
right BoxSummary?

Returns

bool

No documentation is available.

operator !=(BoxSummary?, BoxSummary?)

public static bool operator !=(BoxSummary? left, BoxSummary? right)

Parameters

left BoxSummary?
right BoxSummary?

Returns

bool

No documentation is available.