package ocaml_intrinsics

You can search for identifiers within the package.

in-package search v0.2.0

ocaml_intrinsics
- Ocaml_intrinsics
  - Atomic
    
    Bigstring
    
    Ext_pointer
    
    Native_pointer
  - Atomic_expert
  - Bigstring_intf
  - Conditional
  - Crc
  - Ext_pointer
    
    Bool
    
    Immediate
    
    V
    
    Int
  - Fences
  - Float
  - Int
  - Int32
  - Int64
  - Native_pointer
    
    Bool
    
    V
    
    Expert
    
    Immediate_intf
    
    V
    
    Int
    
    V
  - Nativeint
  - Perfmon
  - Prefetch
  - Prefetch_expert

Legend:
Library
Module
Module type
Parameter
Class
Class type

val iround_half_to_even : float -> int64

Rounds a float to an int64 using the current rounding mode. The default rounding mode is "round half to even", and we expect that no program will change the rounding mode.

If the argument is NaN or infinite or if the rounded value cannot be represented, then the result is unspecified.

On an x86-64 machine, this compiles to cvtsd2si rax, xmm0. On ARM, this calls a C implementation.

val round_half_to_even : float -> float

Rounds a float to an integer float using the current rounding mode. The default rounding mode is "round half to even", and we expect that no program will change the rounding mode.

On an x86-64 machine, this compiles to roundsd xmm0, xmm1, $12. Requires SSE4.1. On ARM, this calls a C implementation.

Rounds a float to an integer float using the mode specified in the function name.

On an x86-64 machine, these compile to roundsd xmm0, xmm1, $N. Requires SSE4.1. On ARM, these call a C implementation.

val round_down : float -> float

val round_up : float -> float

val round_towards_zero : float -> float

val round_nearest : float -> float

include module type of Ocaml_intrinsics_kernel.Float

val min : float -> float -> float

Equivalent to if x < y then x else y.

On an x86-64 machine, this compiles to minsd xmm0, xmm1. On ARM, this calls a C implementation.

val max : float -> float -> float

Equivalent to if x > y then x else y.

On an x86-64 machine, this compiles to maxsd xmm0, xmm1. On ARM, this calls a C implementation.