Struct BigFloat

pub struct BigFloat<M: ManagedTypeApi> { /* private fields */ }

Implementations

impl<M: ManagedTypeApi> BigFloat<M>

pub fn neg(&self) -> Self

pub fn abs(&self) -> Self

pub fn from_big_int(big_int: &BigInt<M>) -> Self

pub fn from_big_uint(big_uint: &BigUint<M>) -> Self

pub fn from_parts( integral_part_value: i32, fractional_part_value: i32, exponent_value: i32, ) -> Self

pub fn from_frac(numerator_value: i64, denominator_value: i64) -> Self

pub fn from_sci(significand_value: i64, exponent_value: i32) -> Self

pub fn trunc(&self) -> BigInt<M>

pub fn floor(&self) -> BigInt<M>

pub fn ceil(&self) -> BigInt<M>

pub fn to_fixed_point(&self, denominator: &BigFloat<M>) -> BigInt<M>

pub fn to_managed_decimal_signed<T: Decimals>( &self, decimals: T, ) -> ManagedDecimalSigned<M, T>

pub fn ln(&self) -> Option<Self>

Computes the natural logarithm of the current number.

The error is around +/- 0.00006, for all inputs.

Will return None for zero or negative numbers.

pub fn zero() -> Self

pub fn from_buffer(managed_buffer: &ManagedBuffer<M>) -> Self

pub fn to_buffer(&self) -> ManagedBuffer<M>

pub unsafe fn new_uninit() -> Self

Creates a new object, without initializing it.

Safety

The value needs to be initialized after creation, otherwise the VM will halt the first time the value is attempted to be read.

impl<M: ManagedTypeApi> BigFloat<M>

pub fn sqrt(&self) -> Self

pub fn pow(&self, exp: i32) -> Self

pub fn sign(&self) -> Sign

Returns the sign of the BigFloat as a Sign.

pub fn magnitude(&self) -> BigFloat<M>

Returns the magnitude of the BigFloat

pub fn to_parts(self) -> (Sign, BigFloat<M>)

Convert this BigFloat into its Sign and its magnitude, the reverse of BigInt::from_biguint.

impl<M: ManagedTypeApi> BigFloat<M>

pub fn to_f64(&self) -> f64

Warning: cannot be used in contracts. It is only meant to simplify certain tests.

It might also not be optimal with respect to precision.

impl<M: ManagedTypeApi> BigFloat<M>

pub fn is_close(&self, other: &Self, abs_tolerance: &Self) -> bool

Trait Implementations

impl<'a, 'b, M: ManagedTypeApi> Add<&'b BigFloat<M>> for &'a BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the + operator.

fn add(self, other: &BigFloat<M>) -> BigFloat<M>

Performs the + operation.

impl<M: ManagedTypeApi> Add for BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the + operator.

fn add(self, other: BigFloat<M>) -> BigFloat<M>

Performs the + operation.

impl<M: ManagedTypeApi> AddAssign<&BigFloat<M>> for BigFloat<M>

fn add_assign(&mut self, other: &BigFloat<M>)

Performs the += operation.

impl<M: ManagedTypeApi> AddAssign for BigFloat<M>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<M: ManagedTypeApi> Clone for BigFloat<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + ManagedTypeApi> Debug for BigFloat<M>

where M::BigFloatHandle: Debug,

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

Formats the value using the given formatter.

impl<'a, 'b, M: ManagedTypeApi> Div<&'b BigFloat<M>> for &'a BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the / operator.

fn div(self, other: &BigFloat<M>) -> BigFloat<M>

Performs the / operation.

impl<M: ManagedTypeApi> Div for BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the / operator.

fn div(self, other: BigFloat<M>) -> BigFloat<M>

Performs the / operation.

impl<M: ManagedTypeApi> DivAssign<&BigFloat<M>> for BigFloat<M>

fn div_assign(&mut self, other: &BigFloat<M>)

Performs the /= operation.

impl<M: ManagedTypeApi> DivAssign for BigFloat<M>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<M: ManagedTypeApi, const DECIMALS: NumDecimals> From<&BigFloat<M>> for ManagedDecimalSigned<M, ConstDecimals<DECIMALS>>

fn from(value: &BigFloat<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&BigInt<M>> for BigFloat<M>

fn from(item: &BigInt<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&BigUint<M>> for BigFloat<M>

fn from(item: &BigUint<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&ManagedBuffer<M>> for BigFloat<M>

fn from(item: &ManagedBuffer<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi, const DECIMALS: NumDecimals> From<BigFloat<M>> for ManagedDecimalSigned<M, ConstDecimals<DECIMALS>>

fn from(value: BigFloat<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<BigInt<M>> for BigFloat<M>

fn from(item: BigInt<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<BigUint<M>> for BigFloat<M>

fn from(item: BigUint<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for BigFloat<M>

fn from(item: ManagedBuffer<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<f32> for BigFloat<M>

fn from(x: f32) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<f64> for BigFloat<M>

fn from(x: f64) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<i16> for BigFloat<M>

fn from(value: i16) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<i32> for BigFloat<M>

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<i64> for BigFloat<M>

fn from(value: i64) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<i8> for BigFloat<M>

fn from(value: i8) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<isize> for BigFloat<M>

fn from(value: isize) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> ManagedType<M> for BigFloat<M>

type OwnHandle = <M as HandleTypeInfo>::BigFloatHandle

fn get_handle(&self) -> M::BigFloatHandle

unsafe fn forget_into_handle(self) -> Self::OwnHandle

Forgets current object (does not run destructor), but extracts the handle.

fn transmute_from_handle_ref(handle_ref: &M::BigFloatHandle) -> &Self

Implement carefully, since the underlying transmutation is an unsafe operation. For types that wrap a handle to some VM-managed data, make sure the type only contains the handle (plus ZSTs if necessary). For types that just wrap another managed type it is easier, call for the wrapped object.

fn transmute_from_handle_ref_mut( handle_ref: &mut M::BigFloatHandle, ) -> &mut Self

fn get_raw_handle(&self) -> RawHandle

fn as_ref(&self) -> ManagedRef<'_, M, Self>

impl<'a, 'b, M: ManagedTypeApi> Mul<&'b BigFloat<M>> for &'a BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the * operator.

fn mul(self, other: &BigFloat<M>) -> BigFloat<M>

Performs the * operation.

impl<M: ManagedTypeApi> Mul for BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the * operator.

fn mul(self, other: BigFloat<M>) -> BigFloat<M>

Performs the * operation.

impl<M: ManagedTypeApi> MulAssign<&BigFloat<M>> for BigFloat<M>

fn mul_assign(&mut self, other: &BigFloat<M>)

Performs the *= operation.

impl<M: ManagedTypeApi> MulAssign for BigFloat<M>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<M: ManagedTypeApi> Neg for BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<M: ManagedTypeApi> NestedDecode for BigFloat<M>

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Self, H::HandledErr>

where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_decode<I>(input: &mut I) -> Result<Self, DecodeError>

where I: NestedDecodeInput,

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

impl<M: ManagedTypeApi> NestedEncode for BigFloat<M>

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H, ) -> Result<(), H::HandledErr>

where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_encode<O>(&self, dest: &mut O) -> Result<(), EncodeError>

where O: NestedEncodeOutput,

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

impl<M: ManagedTypeApi> Ord for BigFloat<M>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<M: ManagedTypeApi> PartialEq<BigInt<M>> for BigFloat<M>

fn eq(&self, other: &BigInt<M>) -> 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<M: ManagedTypeApi> PartialEq<i64> for BigFloat<M>

fn eq(&self, other: &i64) -> 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<M: ManagedTypeApi> PartialEq for BigFloat<M>

fn eq(&self, other: &Self) -> 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<M: ManagedTypeApi> PartialOrd<BigInt<M>> for BigFloat<M>

fn partial_cmp(&self, other: &BigInt<M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<M: ManagedTypeApi> PartialOrd<i64> for BigFloat<M>

fn partial_cmp(&self, other: &i64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<M: ManagedTypeApi> PartialOrd for BigFloat<M>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b, M: ManagedTypeApi> Sub<&'b BigFloat<M>> for &'a BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the - operator.

fn sub(self, other: &BigFloat<M>) -> BigFloat<M>

Performs the - operation.

impl<M: ManagedTypeApi> Sub for BigFloat<M>

type Output = BigFloat<M>

The resulting type after applying the - operator.

fn sub(self, other: BigFloat<M>) -> BigFloat<M>

Performs the - operation.

impl<M: ManagedTypeApi> SubAssign<&BigFloat<M>> for BigFloat<M>

fn sub_assign(&mut self, other: &BigFloat<M>)

Performs the -= operation.

impl<M: ManagedTypeApi> SubAssign for BigFloat<M>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<M: ManagedTypeApi> TopDecode for BigFloat<M>

fn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>

where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_decode<I>(input: I) -> Result<Self, DecodeError>

where I: TopDecodeInput,

Attempt to deserialize the value from input.

impl<M: ManagedTypeApi> TopEncode for BigFloat<M>

fn top_encode_or_handle_err<O, H>( &self, output: O, h: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_encode<O>(&self, output: O) -> Result<(), EncodeError>

where O: TopEncodeOutput,

Attempt to serialize the value to ouput.

impl<M: ManagedTypeApi> TryStaticCast for BigFloat<M>

fn type_eq<U>() -> bool

where U: TryStaticCast,

fn try_cast<U>(self) -> Option<U>

where U: TryStaticCast,

fn try_cast_ref<U>(&self) -> Option<&U>

where U: TryStaticCast,

impl<M: ManagedTypeApi> TypeAbi for BigFloat<M>

type Unmanaged = f64

fn type_name() -> String

fn type_names() -> TypeNames

fn type_name_rust() -> TypeName

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC, )

A type can provide more than its own name. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

impl<M: ManagedTypeApi> Eq for BigFloat<M>

impl<M> TypeAbiFrom<&BigFloat<M>> for BigFloat<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<BigFloat<M>> for BigFloat<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<BigFloat<M>> for f64

where M: ManagedTypeApi,