The type for 2D boxes (rectangles).

dim is the dimension of the boxes of type box2.

The type for 2D vectors.

The type for 2D points.

The type for 2D sizes.

The type for matrices representing linear transformations of 2D space.

v o size is a box whose origin is o and size is size.

v_mid mid size is a box whose mid point is mid and size is size.

empty is the empty box.

o b is the origin of b.

Raises Invalid_argument on empty

ox b is V2.x (o b).

oy b is V2.y (o b).

size b is the size of b.

Raises Invalid_argument on empty

w b is Size2.w (size b).

h b is Size2.h (size b).

zero is a box whose origin and size is zero.

unit is the unit box which extends from zero to one in all dimensions.

of_pts p p' is the smallest box whose space contains p and p'.

add_pt b p is the smallest box whose space contains b and p.

min b is the smallest point of b (its origin).

Raises Invalid_argument on empty

minx b is V2.x (min b).

miny b is V2.y (min b).

max b is the greatest point of b (its size added to the origin).

Raises Invalid_argument on empty

maxx b is V2.x (max b).

maxy b is V2.y (max b).

mid b is the mid point between min and max.

Raises Invalid_argument on empty

midx b is V2.x (mid b).

midy b is V2.y (mid b).

bl b is the bottom-left corner of b.

Raises Invalid_argument on empty

bm_pt b is the bottom-mid point of b.

Raises Invalid_argument on empty

br_pt b is the bottom-right corner of b.

Raises Invalid_argument on empty

ml_pt b is the mid-left corner of b.

Raises Invalid_argument on empty

ml_pt b is {!mid} b.

Raises Invalid_argument on empty

mr_pt b is the mid-right point of b.

Raises Invalid_argument on empty

tl_pt b is the top-left corner of b.

Raises Invalid_argument on empty

tm_pt b is the top-middle corner of b.

Raises Invalid_argument on empty

tr_pt b is the top-right corner of b.

Raises Invalid_argument on empty

area b is the surface area of b.

inter b b' is a box whose space is the intersection of S(b) and S(b').

union b b' is the smallest box whose space contains S(b) and S(b').

inset d b is b whose edges are inset in each dimension according to amounts in d. Negative values in d outset. If the size in dimension i becomes negative it is clamped to 0 and the ith coordinate of the mid point of b is used for the ith coordinate of the resulting box's origin. Returns empty on empty.

round b is the smallest box containing b with integer valued corners. Returns empty on empty.

move d b is b translated by d. Returns empty on empty.

ltr m b is the smallest box containing the corners of b transformed by m. Returns empty on empty.

tr m b is the smallest box containing the corners of b transformed by m in homogenous 2D space. Returns empty on empty.

map_f f b is the box whose origin and size are those of b with their components mapped by f. Returns empty on empty.

is_empty b is true iff b is empty.

is_pt b is true iff b is not empty and its size is equal to 0 in every dimension.

is_seg b is true iff b is not empty and its size is equal to 0 in exactly one dimension.

isects b b' is not (is_empty (inter b b')).

subset b b' is true iff S(b) is included in S(b').

mem p b is true iff p is in S(b).

equal b b' is b = b'.

equal_f eq b b' tests b and b' like equal but uses eq to test floating point values.

compare u v is Stdlib.compare u v.

compare_f cmp b b' compares b and b' like compare but uses cmp to compare floating point values.

pp ppf b prints a textual representation of b on ppf.

pp_f pp_fl ppf b prints b like pp but uses pp_fl to print floating point values.