Lib.rs

Cargo Features

[dependencies]
std-dev = { version = "0.1.0", default-features = false, features = ["base", "regression", "binary_search_rng", "random_subset_regression", "ols", "arbitrary-precision", "percentile-rand", "generic-impls", "bin", "pretty", "completion"] }

default = bin, binary_search_rng, completion, generic-impls, ols, percentile-rand, pretty, random_subset_regression, regression

These default features are set whenever std-dev is added without default-features = false somewhere in the dependency tree.

base = binary_search_rng, generic-impls, percentile-rand

Very commonly used features

regression default arbitrary-precision? bin ols

Library features (also applies to binary)

Affects std-dev::regression…

binary_search_rng default base? bin = rand, rand_xorshift

Enables the random support of the binary search estimator (recommended)

Affects regression::Options.randomness_factor, regression::binary_search.impl_estimator, regression::binary_search.impl_estimator_trig…

random_subset_regression default = rand

Enables speedier regression by only considering random subsets of data

Affects regression::Options.random_subset_regression, regression::random_subset_regression…

ols default bin = nalgebra, regression

Enables the Ordinary Least Squares estimator.

This also allows Theil-Sen polynomial estimator with degrees > 2 and polynomial regression in the best_fit functions.

Affects regression::best_fit_ols, regression::derived.power_ols, regression::derived.exponential_ols, regression::ols…

arbitrary-precision = approx, num-traits, regression, rug, simba

Arbitrary precision for regression.

Increases max degree of polynomial (with good results).
Without this feature, it's basically limited to 10 degrees.

Enables num-traits

Affects regression::arbitrary_linear_algebra…

percentile-rand default base? = rand

Enables the recommended pivot_fn for percentile::* functions.

Affects percentile::percentile_rand, percentile::pivot_fn.rand, percentile::pivot_fn.rand, percentile::cluster.percentile_rand…

generic-impls default base? = num-traits

Allows for generic implementation of traits from this crate.

bin default pretty = binary_search_rng, clap, ols, poloto, regression

Binary features

Required by the binary

pretty default = atty, bin, colored

Prettier bin output

completion default = clap_autocomplete

Shell completion output

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

rand binary_search_rng percentile-rand random_subset_regression

num-traits arbitrary-precision? generic-impls

nalgebra ols

Enables nalgebra ^0.32

simba arbitrary-precision?

Enables simba ^0.8

approx arbitrary-precision?

rug arbitrary-precision?

colored pretty

atty pretty

clap bin

clap_autocomplete completion

poloto bin

Enables poloto ^18

rand_xorshift binary_search_rng