package np

  1. Overview
  2. Docs
package np
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `Finfo
]
type t = [ `Finfo | `Object ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val create : [ `Instance of Py.Object.t | `F of float | `Dtype of Dtype.t ] -> t

finfo(dtype)

Machine limits for floating point types.

Attributes ---------- bits : int The number of bits occupied by the type. eps : float The difference between 1.0 and the next smallest representable float larger than 1.0. For example, for 64-bit binary floats in the IEEE-754 standard, ``eps = 2**-52``, approximately 2.22e-16. epsneg : float The difference between 1.0 and the next smallest representable float less than 1.0. For example, for 64-bit binary floats in the IEEE-754 standard, ``epsneg = 2**-53``, approximately 1.11e-16. iexp : int The number of bits in the exponent portion of the floating point representation. machar : MachAr The object which calculated these parameters and holds more detailed information. machep : int The exponent that yields `eps`. max : floating point number of the appropriate type The largest representable number. maxexp : int The smallest positive power of the base (2) that causes overflow. min : floating point number of the appropriate type The smallest representable number, typically ``-max``. minexp : int The most negative power of the base (2) consistent with there being no leading 0's in the mantissa. negep : int The exponent that yields `epsneg`. nexp : int The number of bits in the exponent including its sign and bias. nmant : int The number of bits in the mantissa. precision : int The approximate number of decimal digits to which this kind of float is precise. resolution : floating point number of the appropriate type The approximate decimal resolution of this type, i.e., ``10**-precision``. tiny : float The smallest positive usable number. Type of `tiny` is an appropriate floating point type.

Parameters ---------- dtype : float, dtype, or instance Kind of floating point data-type about which to get information.

See Also -------- MachAr : The implementation of the tests that produce this information. iinfo : The equivalent for integer data types. spacing : The distance between a value and the nearest adjacent number nextafter : The next floating point value after x1 towards x2

Notes ----- For developers of NumPy: do not instantiate this at the module level. The initial calculation of these parameters is expensive and negatively impacts import times. These objects are cached, so calling ``finfo()`` repeatedly inside your functions is not a problem.

val bits : t -> int

Attribute bits: get value or raise Not_found if None.

val bits_opt : t -> int option

Attribute bits: get value as an option.

val eps : t -> float

Attribute eps: get value or raise Not_found if None.

val eps_opt : t -> float option

Attribute eps: get value as an option.

val epsneg : t -> float

Attribute epsneg: get value or raise Not_found if None.

val epsneg_opt : t -> float option

Attribute epsneg: get value as an option.

val iexp : t -> int

Attribute iexp: get value or raise Not_found if None.

val iexp_opt : t -> int option

Attribute iexp: get value as an option.

val machar : t -> Py.Object.t

Attribute machar: get value or raise Not_found if None.

val machar_opt : t -> Py.Object.t option

Attribute machar: get value as an option.

val machep : t -> int

Attribute machep: get value or raise Not_found if None.

val machep_opt : t -> int option

Attribute machep: get value as an option.

val max : t -> Py.Object.t

Attribute max: get value or raise Not_found if None.

val max_opt : t -> Py.Object.t option

Attribute max: get value as an option.

val maxexp : t -> int

Attribute maxexp: get value or raise Not_found if None.

val maxexp_opt : t -> int option

Attribute maxexp: get value as an option.

val min : t -> Py.Object.t

Attribute min: get value or raise Not_found if None.

val min_opt : t -> Py.Object.t option

Attribute min: get value as an option.

val minexp : t -> int

Attribute minexp: get value or raise Not_found if None.

val minexp_opt : t -> int option

Attribute minexp: get value as an option.

val negep : t -> int

Attribute negep: get value or raise Not_found if None.

val negep_opt : t -> int option

Attribute negep: get value as an option.

val nexp : t -> int

Attribute nexp: get value or raise Not_found if None.

val nexp_opt : t -> int option

Attribute nexp: get value as an option.

val nmant : t -> int

Attribute nmant: get value or raise Not_found if None.

val nmant_opt : t -> int option

Attribute nmant: get value as an option.

val precision : t -> int

Attribute precision: get value or raise Not_found if None.

val precision_opt : t -> int option

Attribute precision: get value as an option.

val resolution : t -> Py.Object.t

Attribute resolution: get value or raise Not_found if None.

val resolution_opt : t -> Py.Object.t option

Attribute resolution: get value as an option.

val tiny : t -> float

Attribute tiny: get value or raise Not_found if None.

val tiny_opt : t -> float option

Attribute tiny: get value as an option.

val to_string : t -> string

Print the object to a human-readable representation.

val show : t -> string

Print the object to a human-readable representation.

val pp : Stdlib.Format.formatter -> t -> unit

Pretty-print the object to a formatter.