Struct QuantileBinning 

pub struct QuantileBinning {
    pub num_bins: usize,
}

Fields

num_bins: usize

Implementations

impl QuantileBinning

pub fn new(num_bins: usize) -> PyResult<Self>

impl QuantileBinning

pub fn compute_edges<F>( &self, arr: &ArrayView1<'_, F>, ) -> Result<Vec<F>, TypeError>

where F: Float + FromPrimitive,

Computes quantile edges for binning using the R-7 method (Hyndman & Fan Type 7).

This implementation follows the R-7 quantile definition from: Hyndman, R. J. and Fan, Y. (1996) “Sample quantiles in statistical packages,” The American Statistician, 50(4), pp. 361-365.

The R-7 method uses the formula:

• m = 1 - p
• j = floor(np + m)
• h = np + m - j
• Q(p) = (1 - h) × x[j] + h × x[j+1]

This method is the default in many statistical packages, median-unbiased quantile estimates that are approximately unbiased for normal distributions.

Arguments

• arr - Sorted array of data values

Returns

• Ok(Vec<F>) - Vector of quantile edge values for binning
• Err(DriftError) - If insufficient data points for quantile calculation

Reference

PDF: https://www.amherst.edu/media/view/129116/original/Sample+Quantiles.pdf

Trait Implementations

impl Clone for QuantileBinning

fn clone(&self) -> QuantileBinning

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuantileBinning

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QuantileBinning

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QuantileBinning

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for QuantileBinning

type Target = QuantileBinning

The Python output type

type Output = Bound<'py, <QuantileBinning as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for QuantileBinning

fn eq(&self, other: &QuantileBinning) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for QuantileBinning

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for QuantileBinning

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<QuantileBinning>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for QuantileBinning

const TEXT_SIGNATURE: &'static str = "(num_bins=10)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder QuantileBinning

type Holder = Option<PyClassGuard<'a, QuantileBinning>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut QuantileBinning

type Holder = Option<PyClassGuardMut<'a, QuantileBinning>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<QuantileBinning> for PyClassImplCollector<QuantileBinning>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for QuantileBinning

const NAME: &'static str = "QuantileBinning"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for QuantileBinning

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for QuantileBinning

impl StructuralPartialEq for QuantileBinning