File: fcl_fdArray.mli

package info (click to toggle)
facile 1.1.4-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 716 kB
  • sloc: ml: 6,862; makefile: 90
file content (40 lines) | stat: -rw-r--r-- 2,251 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
(***********************************************************************)
(*                                                                     *)
(*                           FaCiLe                                    *)
(*                 A Functional Constraint Library                     *)
(*                                                                     *)
(*            Nicolas Barnier, Pascal Brisset, LOG, CENA               *)
(*                                                                     *)
(* Copyright 2004 CENA. All rights reserved. This file is distributed  *)
(* under the terms of the GNU Lesser General Public License.           *)
(***********************************************************************)
(* $Id: fcl_fdArray.mli,v 1.15 2003/02/03 15:50:48 brisset Exp $ *)

(** Constraints over Arrays of Variables *)

val min : Fcl_var.Fd.t array -> Fcl_var.Fd.t
val max : Fcl_var.Fd.t array -> Fcl_var.Fd.t
(** [min vars] (resp. [max vars]) returns a variable constrained to be equal
   to the variable that will be instantiated to the minimal (resp. maximal)
   value among all the variables in the array [vars]. Raises
   [Invalid_argument] if [vars] is empty. Not reifiable. *)

val min_cstr : Fcl_var.Fd.t array -> Fcl_var.Fd.t -> Fcl_cstr.t
val max_cstr : Fcl_var.Fd.t array -> Fcl_var.Fd.t -> Fcl_cstr.t
(** [min_cstr vars mini] (resp. [max_cstr vars maxi]) returns the constraint
   [fd2e (min vars) =~ fd2e mini] (resp. [fd2e (max vars) =~ fd2e maxi]).
   Raises [Invalid_argument] if [vars] is empty. Not reifiable. *) 

val get : Fcl_var.Fd.t array ->  Fcl_var.Fd.t -> Fcl_var.Fd.t
(** [get vars index] returns a variable constrained to be equal to
   [vars.(index)]. Variable [index] is constrained within the range of
   the valid indices of the array [(0..Array.length vars - 1)]. Raises
   [Invalid_argument] if [vars] is empty.
   Not reifiable. *)

val get_cstr : Fcl_var.Fd.t array -> Fcl_var.Fd.t -> Fcl_var.Fd.t -> Fcl_cstr.t
(** [get_cstr vars index v] returns the constraint
   [fd2e vars.(index) =~ fd2e v]. Variable [index] is constrained within
   the range of the valid indices of the array [(0..Array.length vars - 1)].
   Raises [Invalid_argument] if [vars] is empty. Not reifiable. *)