package safemoney

  1. Overview
  2. Docs
package safemoney
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Qv : Qv_intf.S

Signature

exception CurrencyTypeMismatch of string
type t = {
  1. symbol : string;
    (*

    Currency Symbol

    *)
  2. value : Qv.t;
    (*

    Value in Rational

    *)
}

Types

include Ppx_compare_lib.Comparable.S with type t := t
val compare : t Base__Ppx_compare_lib.compare
type showable = {
  1. symbol_ : string;
  2. value_ : string;
}

showable for t

val showable_to_yojson : showable -> Yojson.Safe.t
val showable_of_yojson : Yojson.Safe.t -> showable Ppx_deriving_yojson_runtime.error_or
val pp_showable : Ppx_deriving_runtime.Format.formatter -> showable -> Ppx_deriving_runtime.unit
val show_showable : showable -> Ppx_deriving_runtime.string
val sexp_of_showable : showable -> Sexplib0.Sexp.t
val showable_of_sexp : Sexplib0.Sexp.t -> showable
val make_qv : (string * Qv.t) -> t

Construction

Construct quotient value, e.g. make_qv "GBP" Utils.make_q("123456/100")

val show_sym : t -> unit

Print the currency symbol

val show_val : t -> unit

Print the currency value

val show_t : t -> unit

Print the quotient value

val neg : t -> t

Negate a quotient value

val abs : t -> t

Return an absolute quotient value

val (+) : t -> t -> t

Add two quotient values with same symbol as required

val (-) : t -> t -> t

Substract two quotient values with same symbol as required

val (*) : t:t -> value:Qv.t -> t

Multiply a quotient value with a plain rational value. Multiplying two quotient values does not make sense for currency ops.

val (/) : t -> Qv.t -> t

Divide a quotient value with a plain rational value. Dividing two quotient values does not make sense for currency ops.

val to_showable_json : t -> string

Convert t to showable rep

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct