Skip to main content

DataFrameEqualOptions

Struct DataFrameEqualOptions 

Source
pub struct DataFrameEqualOptions {
    pub check_row_order: bool,
    pub check_column_order: bool,
    pub check_dtypes: bool,
    pub check_exact: bool,
    pub rel_tol: f64,
    pub abs_tol: f64,
    pub categorical_as_str: bool,
}
Expand description

Configuration options for comparing DataFrame equality.

Controls the behavior of DataFrame equality comparisons by specifying which aspects to check and the tolerance for floating point comparisons.

Fields§

§check_row_order: bool

Whether to check that rows appear in the same order.

§check_column_order: bool

Whether to check that columns appear in the same order.

§check_dtypes: bool

Whether to check that the data types match for corresponding columns.

§check_exact: bool

Whether to check for exact equality (true) or approximate equality (false) for floating point values.

§rel_tol: f64

Relative tolerance for approximate equality of floating point values.

§abs_tol: f64

Absolute tolerance for approximate equality of floating point values.

§categorical_as_str: bool

Whether to compare categorical values as strings.

Implementations§

Source§

impl DataFrameEqualOptions

Source

pub fn new() -> Self

Creates a new DataFrameEqualOptions with default settings.

Source

pub fn with_check_row_order(self, value: bool) -> Self

Sets whether to check that rows appear in the same order.

Source

pub fn with_check_column_order(self, value: bool) -> Self

Sets whether to check that columns appear in the same order.

Source

pub fn with_check_dtypes(self, value: bool) -> Self

Sets whether to check that data types match for corresponding columns.

Source

pub fn with_check_exact(self, value: bool) -> Self

Sets whether to check for exact equality (true) or approximate equality (false) for floating point values.

Source

pub fn with_rel_tol(self, value: f64) -> Self

Sets the relative tolerance for approximate equality of floating point values.

Source

pub fn with_abs_tol(self, value: f64) -> Self

Sets the absolute tolerance for approximate equality of floating point values.

Source

pub fn with_categorical_as_str(self, value: bool) -> Self

Sets whether to compare categorical values as strings.

Trait Implementations§

Source§

impl Default for DataFrameEqualOptions

Source§

fn default() -> Self

Creates a new DataFrameEqualOptions with default settings.

Default configuration:

  • Checks row order, column order, and data types
  • Uses approximate equality comparisons for floating point values
  • Sets relative tolerance to 1e-5 and absolute tolerance to 1e-8 for floating point comparisons
  • Does not convert categorical values to strings for comparison

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V