Header menu logo Nu

Relation Module

Relation functions.

Functions and values

Function or value Description

Relation.changeType relation

Full Usage: Relation.changeType relation

Parameters:
Returns: 'a Relation

Change the type of an address.

relation : 'a Relation
Returns: 'a Relation

Relation.equals left right

Full Usage: Relation.equals left right

Parameters:
Returns: bool

Test relation equality.

left : 'a Relation
right : 'a Relation
Returns: bool

Relation.getLinks relation

Full Usage: Relation.getLinks relation

Parameters:
Returns: Link array

Get the links of a relation.

relation : 'a Relation
Returns: Link array

Relation.makeCurrent ()

Full Usage: Relation.makeCurrent ()

Parameters:
    () : unit

Returns: 'a Relation

Make a current relation.

() : unit
Returns: 'a Relation

Relation.makeFromArray links

Full Usage: Relation.makeFromArray links

Parameters:
    links : Link array

Returns: 'a Relation

Make a relation from an array of links.

links : Link array
Returns: 'a Relation

Relation.makeFromList links

Full Usage: Relation.makeFromList links

Parameters:
Returns: 'a Relation

Make a relation from a list of links.

links : Link list
Returns: 'a Relation

Relation.makeFromSeq links

Full Usage: Relation.makeFromSeq links

Parameters:
    links : Link array

Returns: 'a Relation

Make a relation from a sequence of links.

links : Link array
Returns: 'a Relation

Relation.makeFromString relationStr

Full Usage: Relation.makeFromString relationStr

Parameters:
    relationStr : string

Returns: 'a Relation

Make a relation from a '/' delimited string.

relationStr : string
Returns: 'a Relation

Relation.makeParent ()

Full Usage: Relation.makeParent ()

Parameters:
    () : unit

Returns: 'a Relation

Make a parent relation.

() : unit
Returns: 'a Relation

Type something to start searching.