org.colomoto.mddlib

Class PathSearcher

java.lang.Object

org.colomoto.mddlib.PathSearcher

All Implemented Interfaces:

Iterable<Integer>

public class PathSearcher
extends Object
implements Iterable<Integer>

Iterate over the paths in MDDs, optionally filtering on the leaf values.

It provides an integer array defining the path (reused for each path) and returns the leaf value for each path found. In the path representation, some variables may have undefined values, meaning that their value does not change the reached leaf.

It implements Iterable, so you can use a for loop on it directly. Note that the bundled iterator will fill the path automatically, so that you do not have to call fillPath explicitly but you will have to do it when using the raw searcher.

The same path searcher can be reused for different MDDs.

Warning: the provided iterator changes the instance: you can not use several iterators separately as their next() method will affect each other.

Author:

Aurelien Naldi

Constructor Summary

Constructors

Constructor and Description
PathSearcher(MDDManager ddmanager) Create a new path searcher accepting any value (negative leaves are not allowed)
PathSearcher(MDDManager ddmanager, boolean detectIntervals) Create a new path searcher accepting any value (negative leaves are not allowed) and detecting intervals
PathSearcher(MDDManager ddmanager, int value) Create a new path searcher, with a single value.
PathSearcher(MDDManager ddmanager, int value, boolean detectIntervals) Create a new path searcher, with a single value and detecting intervals
PathSearcher(MDDManager ddmanager, int minvalue, int maxvalue) Create a new path searcher, with a value range.
PathSearcher(MDDManager ddmanager, int minvalue, int maxvalue, boolean detectIntervals)

Method Summary

Modifier and Type	Method and Description
int	countPaths() Count the number of paths found for the current node.
int[]	getMax() Get the int[] used to store max values if this searcher detects intervals.
int[]	getPath() Get the int[] used to store the found path.
Iterator<Integer>	iterator()
int[]	setNode(int node) Start looking up path for a new node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PathSearcher

public PathSearcher(MDDManager ddmanager)

Create a new path searcher accepting any value (negative leaves are not allowed)

Parameters:

ddmanager - The MDD manager in which this search works.

PathSearcher

public PathSearcher(MDDManager ddmanager,
                    boolean detectIntervals)

Create a new path searcher accepting any value (negative leaves are not allowed) and detecting intervals

Parameters:

ddmanager - The MDD manager in which this search works.

detectIntervals -

PathSearcher

public PathSearcher(MDDManager ddmanager,
                    int value)

Create a new path searcher, with a single value.

Parameters:

ddmanager - The MDD manager in which this search works.

value - The value of the reached leaf

PathSearcher

public PathSearcher(MDDManager ddmanager,
                    int value,
                    boolean detectIntervals)

Create a new path searcher, with a single value and detecting intervals

Parameters:

ddmanager - The MDD manager in which this search works.

value - The value of the reached leaf

PathSearcher

public PathSearcher(MDDManager ddmanager,
                    int minvalue,
                    int maxvalue)

Create a new path searcher, with a value range.

Parameters:

ddmanager - The MDD manager in which this search works.

minvalue - minimal value of the reached leaves

maxvalue - maximal value of the reached leaves

PathSearcher

public PathSearcher(MDDManager ddmanager,
                    int minvalue,
                    int maxvalue,
                    boolean detectIntervals)

Method Detail

setNode

public int[] setNode(int node)

Start looking up path for a new node.

Note that the node must come from the same MDD manager. For performance reasons, the same array will be reused when searching for the next path, copy its content if you need to keep it.

Parameters:

node - a new node index

Returns:

a reusable array denoting a path to a valid leaf or null if no more leaf are found

getPath

public int[] getPath()

Get the int[] used to store the found path. This returns the same array as setNode(int) and is only provided as convenience when you obtained a pre-configured searcher.

Returns:

a reusable array denoting a path to a valid leaf or null if no more leaf are found

getMax

public int[] getMax()

Get the int[] used to store max values if this searcher detects intervals.

Returns:

a reusable array in which intervals will be stored, or null if the searcher does not support it.

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

countPaths

public int countPaths()

Count the number of paths found for the current node. Note that this will enumerate all paths (using the associated iterator)

Returns:

the number of paths found