package range

  1. Overview
  2. Docs
package range
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module RangeSource

Range module provide a type for handling the description of an integer sequence described by a start value and a stop value. This module provide functions to fold this range, and some basic set operation likes cross and join.

The main goal is to provide a split capacity in order to make life easy for distributed processing.

  • author Aldrik KLEBER
Sourcetype t

t type correspond to a integer range value

Sourceval from : int -> int -> t

from int_value -> int_value will create a t value representing the range described by the two values given in parameter.

  • parameter start

    Integer representating the starting value of the range

  • parameter stop

    Integer representing the last value of the range

  • returns

    Range.t type which value defined by start and stop parameters

Sourceval filter : (int -> bool) -> t -> t

filter on predicate function attach a predicate that will modify the behaviour of iter or fold funtions in order to apply only to values that satisfies the predicate.

  • parameter predicate

    the predicate is attached to the range value, the predicate must respect the signature int -> bool

  • parameter Range.t

    value if the range provided has already a filter, the new range value will merge the two filters.

  • returns

    new Range.t value with a new filter added. *

Sourceval filtered_from : int -> int -> (int -> bool) -> t

create a new range of integer with a filter

Application of f is delayed. Filters and map functions can be stacked.

  • parameter start

    Integer representating the starting value of the range

  • parameter stop

    Integer representing the last value of the range

  • parameter predicate

    the predicate is attached to the range value, the predicate must respect the signature int -> bool

  • returns

    new Range.t type which value defined by start and stop parameters *

Sourceval reset : t -> t

remove all map and filter effects from a range.

  • parameter old

    Range.t value

  • returns

    new Range.t value from parameter without modifiers. *

Sourceval is_natural : t -> bool

is filtered predicate

test if a Range.t value contain a filter or map function transforming data.

  • parameter Range.t

    value to test

  • returns

    test true if there is a filter false otherwise *

Sourceval fold : ('a -> int -> 'a) -> 'a -> t -> 'a

fold the equivalent of List.fold_left applied to integer range_record explore all the values contained in the rang value applying f to the accumulator and the current element read by fold. If a filter was associated to the range value, only element validated by the predicate f will be passed to the function.

  • parameter f

    function aggregating the accumulator to the current value.

  • parameter acc

    initial value of the accumulator

  • parameter range

    explored range value

  • returns

    value of the accumulator after reading all elements *

Sourceval iter : (int -> unit) -> t -> unit

iter apply a function with side effect on all values of the range. This function support filtering.

  • parameter f

    function receiving an integer and returning unit

  • parameter range

    value

  • returns

    unit *

Sourceval split : int -> int -> t -> t list

split a range value into a list of smaller range, useful for batching in parallel processing.

  • parameter minimal

    size of a range

  • parameter count

    number of subranges contained in the list.

  • parameter range

    value to split

  • returns

    list of ranges with a size of minimal or greater, the list having count elements max. *

Sourceval contain : int -> t -> bool

contain function to test if an integer value is contained in a Range.t values

  • parameter element

    to be tested

  • parameter reference

    range value

  • returns

    true if element is contained in reference *

Sourceval cross : t -> t -> (t, string) result

new Range.t value representing the common value between two Range.t values.

  • parameter a

    Range.t value

  • parameter b

    Range.t value

  • returns

    Result type with a Range.t value defined by the common values, and Error string message if it is impossible to find common values. *

Sourceval cross_exn : t -> t -> t

Same as cross function with exception for error handling. *

Sourceval join : t -> t -> (t, string) result

Join to generate a new Range.t value contained both a and b

  • parameter a

    Range.t value

  • parameter b

    Range.t value

  • returns

    Result type with a Range.t value containing both a and b. If a and b are disjoint, they can't be joinded so an Error string message is returned. *

Sourceval join_exn : t -> t -> t

Same as join with exception for error handling *

Sourceval map : (int -> int) -> t -> t

apply f to elements contained in a Range.t value

This feature used a delayed application of f. Like for filters, f is stacked on previous filter or map functions.

  • parameter f

    function to apply to the content of a range value

  • parameter r

    range to modify

  • returns

    updated range *

Sourceval aggregate : (int -> int -> int) -> t -> t -> t

agregate the limits of a range through a function.

  • parameter f

    function to aggregate an integer

  • parameter a

    range a to be aggregated to b

  • parameter b

    range b aggregated to a

  • returns

    a new range *

Sourceval to_string : t -> string

export limits of a range to a string.

The presence of functions that can modifiy the content is signaled by "M:" prefix

  • parameter r

    Range.t value to export in a string .

  • returns

    string representing the content of r Range.t value. *