Package jsetl

Class LMap

java.lang.Object

jsetl.LObject

jsetl.LCollection

jsetl.LSet

jsetl.LRel

jsetl.LMap

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<java.lang.Object>

public class LMap
extends LRel
implements java.lang.Cloneable

Instances of this class are logical maps, i.e., logical sets whose elements are logical pairs that denote partial functions. Partial functions are binary relations in which there can't be two pairs with the same first element and different second element.

Field Summary

Fields inherited from class jsetl.LObject

USEJOLLYTOKEN

Constructor Summary

Constructors

Constructor	Description
LMap()	Constructs an unspecified logical map with default name.
LMap(java.lang.String name)	Constructs an unbound logical map with given name.
LMap(java.lang.String name, java.util.Set<LPair> set)	Constructs a bound and closed logical map whose elements are those in set and with a given name.
LMap(java.lang.String name, LMap lMap)	Constructs a logical map which is equal to the parameter lMap and with given name.
LMap(java.util.Set<LPair> set)	Constructs a bound and closed logical map whose elements are those in set and with a default name.
LMap(LMap lMap)	Constructs a logical map which is equal to the parameter lMap and with default name.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(jsetl.Visitor visitor)	Implementation of this method is needed for the Visitor design pattern.
LMap	clone()	Creates a bit-by-bit clone of this LMap.
Constraint	comp(LMap lMap1, LMap lMap2)	This method creates the "comp" constraint which requires that this comp lMap1 = lMap2.
Constraint	dom(LSet dom)	This method creates the "dom" constraint.
static LMap	empty()	Creates an empty LMap.
LMap	ins(LPair lPair)	Creates and returns a new logical map obtained from the union of this with {lPair}.
LMap	ins(LPair... lPairs)	Creates and returns a new logical map obtained from the union of this with the set of lPairs.
LMap	insAll(java.util.ArrayList<LPair> newElements)	Creates and returns a new logical set obtained from this by adding all elements of the parameter newElements.
LMap	insAll(LPair[] lPairs)	Creates and returns a new logical map obtained from this by adding all elements of the parameter lPairs.
Constraint	pfun()	This method creates the "pfun" constraint, which is satisfied if and only if this represents a partial function.
Constraint	ran(LSet ran)	This method creates the "ran" constraint.
LMap	setName(java.lang.String name)	Sets the name of this LMap to name.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class jsetl.LCollection

forallElems, isClosed, isEmpty, isGround, iterator, testContains, toArray

Methods inherited from class jsetl.LObject

getName, in, in, isBound, isGround, nin, nin, output

Methods inherited from class jsetl.LRel

comp, dres, getValue, id, id, inv, ncomp, ndom, ndres, nid, ninv, nran, nrres, rres, setValue

Methods inherited from class jsetl.LSet

contains, diff, diff, diff, diff, disj, disj, eq, eq, equals, getSize, getTail, ins, insAll, insAll, inters, inters, inters, inters, less, less, less, less, mkSet, ncontains, ndiff, ndiff, ndiff, ndiff, ndisj, ndisj, neq, neq, ninters, ninters, ninters, ninters, normalizeSet, nsubset, nsubset, nunion, nunion, nunion, nunion, occurs, printElems, size, size, subset, subset, toString, union, union, union, union

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LMap

public LMap()

Constructs an unspecified logical map with default name.

LMap

public LMap(@NotNull
            java.lang.String name)

Constructs an unbound logical map with given name.

Parameters:

name - name of the logical map.

LMap

public LMap(@NotNull
            java.util.Set<LPair> set)

Constructs a bound and closed logical map whose elements are those in set and with a default name.

Parameters:

set - a java set whose elements will be the elements of the constructed logical map. It must not contain null values.

Throws:

java.lang.NullPointerException - if set contains null values.

NotPFunException - if set does not represent a partial function.

LMap

public LMap(@NotNull
            java.lang.String name,
            @NotNull
            java.util.Set<LPair> set)

Constructs a bound and closed logical map whose elements are those in set and with a given name.

Parameters:

set - a java set whose elements will be the elements of the constructed logical map. It must not contain null values.

name - the name of the logical map.

Throws:

java.lang.NullPointerException - if set contains null values.

NotPFunException - if set does not represent a partial function.

LMap

public LMap(@NotNull
            LMap lMap)

Constructs a logical map which is equal to the parameter lMap and with default name. This constructor is equivalent to solving the constraint this.eq(lMap).

Parameters:

lMap - the logical map to which the constructed logical map is equal.

LMap

public LMap(@NotNull
            java.lang.String name,
            @NotNull
            LMap lMap)

Constructs a logical map which is equal to the parameter lMap and with given name. This constructor is equivalent to solving the constraint this.eq(lMap).

Parameters:

name - name of the logical map.

lMap - the map to which the constructed logical map is equal.

Method Detail

empty

@NotNull
public static LMap empty()

Creates an empty LMap.

Returns:

an empty LMap.

accept

@Nullable
public java.lang.Object accept(@NotNull
                               jsetl.Visitor visitor)

Implementation of this method is needed for the Visitor design pattern.

Overrides:

accept in class LRel

Parameters:

visitor - the visitor that wants to visit the object.

Returns:

the result of the call to visitor.visit(this).

setName

@NotNull
public LMap setName(@NotNull
                    java.lang.String name)

Sets the name of this LMap to name.

Overrides:

setName in class LRel

Parameters:

name - name for this LMap.

Returns:

the object on which this method was invoked.

ins

@NotNull
public LMap ins(@NotNull
                LPair lPair)

Creates and returns a new logical map obtained from the union of this with {lPair}. The invocation object is not modified.

Overrides:

ins in class LRel

Parameters:

lPair - the logical pair to use when creating the new set.

Returns:

returns a (new) logical map obtained by adding lPair to this logical map.

ins

@NotNull
public LMap ins(@NotNull
                LPair... lPairs)

Creates and returns a new logical map obtained from the union of this with the set of lPairs. The invocation object is not modified.

Overrides:

ins in class LRel

Parameters:

lPairs - the logical pairs to use when creating the new set. None of its elements can be null

Returns:

returns a (new) logical map obtained by adding lPairs to this logical map.

Throws:

java.lang.NullPointerException - if some of the elements in lPairs are null.

insAll

@NotNull
public LMap insAll(@NotNull
                   LPair[] lPairs)

Creates and returns a new logical map obtained from this by adding all elements of the parameter lPairs. Does not modify this logical map.

Overrides:

insAll in class LRel

Parameters:

lPairs - array of elements to add. None of its elements can be null.

Returns:

the constructed logical map.

Throws:

java.lang.NullPointerException - if at least one of the elements in objects is null.

insAll

@NotNull
public LMap insAll(@NotNull
                   java.util.ArrayList<LPair> newElements)

Creates and returns a new logical set obtained from this by adding all elements of the parameter newElements. Does not modify this logical map.

Overrides:

insAll in class LRel

Parameters:

newElements - collection of elements to add. None of its elements can be null.

Returns:

the constructed logical map.

Throws:

java.lang.NullPointerException - if at least one of the elements in newElements is null.

clone

@NotNull
public LMap clone()

Creates a bit-by-bit clone of this LMap.

Overrides:

clone in class LRel

Returns:

a clone of this LMap.

pfun

@NotNull
public Constraint pfun()

This method creates the "pfun" constraint, which is satisfied if and only if this represents a partial function. Note: this constraint should be posted together with other methods such as "eq", "in" and so on to ensure that the logical map still represents a partial function even after the resolution of those constraints (which don't take into account the nature of partial function of the objects of class LMAp.

Returns:

the constructed constraint.

dom

@NotNull
public Constraint dom(@NotNull
                      LSet dom)

This method creates the "dom" constraint.

Overrides:

dom in class LRel

Parameters:

dom - : domain of the LMap on which this method is invoked. It is the domain of this logical map.

Returns:

the constructed constraint.

ran

@NotNull
public Constraint ran(@NotNull
                      LSet ran)

This method creates the "ran" constraint.

Overrides:

ran in class LRel

Parameters:

ran - : range of the LMap on which this method is invoked. It is the range of this logical map.

Returns:

constructed constraint.

comp

@NotNull
public Constraint comp(@NotNull
                       LMap lMap1,
                       @NotNull
                       LMap lMap2)

This method creates the "comp" constraint which requires that this comp lMap1 = lMap2.

Parameters:

lMap1 - second argument of the functional composition.

lMap2 - result of the functional composition.

Returns:

the constructed constraint.