Source

caml2geom / caml2geom.mli

Full commit
(*
  Copyright (c) 2011 Barry Schwartz

  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation
  files (the "Software"), to deal in the Software without
  restriction, including without limitation the rights to use,
  copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following
  conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  OTHER DEALINGS IN THE SOFTWARE.
*)

module type Fragment =
sig
  type t
  type output_type
  val is_zero : t -> bool
  val is_constant : t -> bool
  val is_finite : t -> bool
  val at0 : t -> output_type
  val at1 : t -> output_type
  val value_at : t -> float -> output_type
end

module D2 :
sig
  module type S =
  sig
    type elt
    type t
    val make : elt -> elt -> t
    val coord : t -> int -> elt
    val fst : t -> elt
    val snd : t -> elt
    val is_zero : t -> bool
    val is_constant : t -> bool
    val is_finite : t -> bool
  end

  module Make(Elt : Fragment) : S with type elt = Elt.t
end

module Coord :
sig
  type t = float
  val epsilon : t
  external infinity : unit -> t = "infinity_wrapper"
  external are_near : t -> t -> bool = "are_near_wrapper"
  external are_near_eps : t -> t -> t -> bool = "are_near_eps_wrapper"
  external rel_error_bound : t -> t -> bool = "rel_error_bound_wrapper"
  external rel_error_bound_eps : t -> t -> t -> bool = "rel_error_bound_eps_wrapper"
end

module Int_coord :
sig
  type t = int
end

module Point :
sig
  type t
  external make : Coord.t -> Coord.t -> t = "new_point_wrapper"
  external copy : t -> t = "copy_point_wrapper"
  external coord : t -> int -> Coord.t = "point_coord_wrapper"
  external set_coord : t -> int -> Coord.t -> unit = "set_point_coord_wrapper"
  external length : t -> Coord.t = "point_length_wrapper"
  external normalize : t -> unit = "point_normalize_wrapper"
  external ccw : t -> t = "point_ccw_wrapper"
  external cw : t -> t = "point_cw_wrapper"
  external neg : t -> t = "point_neg_wrapper"
  external set : t -> t -> unit = "point_set_wrapper"
  external add_to : t -> t -> unit = "point_add_to_wrapper"
  external sub_from : t -> t -> unit = "point_sub_from_wrapper"
  external mul_by : t -> Coord.t -> unit = "point_mul_by_wrapper"
  external div_by : t -> Coord.t -> unit = "point_div_by_wrapper"
end

module Bezier :
sig
  type t
  type output_type = Coord.t
  external make_order3 : Coord.t -> Coord.t -> Coord.t -> Coord.t -> t = "new_bezier_order3_wrapper"
  external is_zero : t -> bool = "bezier_is_zero_wrapper"
  external is_constant : t -> bool = "bezier_is_constant_wrapper"
  external is_finite : t -> bool = "bezier_is_finite_wrapper"
  external at0 : t -> Coord.t = "bezier_at0_wrapper"
  external at1 : t -> Coord.t = "bezier_at1_wrapper"
  external value_at : t -> float -> Coord.t = "bezier_value_at_wrapper"
end

module Bezier_as_fragment : Fragment