ai.libs.jaicore.ml.dyadranking.search

Class ADyadRankedNodeQueue<N,V extends java.lang.Comparable<V>>

java.lang.Object

ai.libs.jaicore.ml.dyadranking.search.ADyadRankedNodeQueue<N,V>

Type Parameters:

N - First node parameter

V - Second node parameter

All Implemented Interfaces:

java.lang.Iterable<ai.libs.jaicore.search.model.travesaltree.Node<N,V>>, java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V>>, java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V>>

public abstract class ADyadRankedNodeQueue<N,V extends java.lang.Comparable<V>>
extends java.lang.Object
implements java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V>>

A queue whose elements are nodes, sorted by a dyad ranker.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractDyadScaler	scaler for scaling the dyads

Constructor Summary

Constructors

Constructor and Description
ADyadRankedNodeQueue(ai.libs.jaicore.math.linearalgebra.Vector contextCharacterization) Constructs a new DyadRankedNodeQueue that ranks the nodes in the queue according to the given context characterization.
ADyadRankedNodeQueue(ai.libs.jaicore.math.linearalgebra.Vector contextCharacterization, IDyadRanker dyadRanker, AbstractDyadScaler scaler) Constructs a new DyadRankedNodeQueue that ranks the nodes in the queue according to the given context characterization and given dyad ranker.

Method Summary

Modifier and Type	Method and Description
boolean	add(ai.libs.jaicore.search.model.travesaltree.Node<N,V> e)
boolean	addAll(java.util.Collection<? extends ai.libs.jaicore.search.model.travesaltree.Node<N,V>> c)
protected abstract ai.libs.jaicore.math.linearalgebra.Vector	characterize(ai.libs.jaicore.search.model.travesaltree.Node<N,V> node) Provide a characterization of the given node to be used by the dyad ranker.
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
ai.libs.jaicore.search.model.travesaltree.Node<N,V>	element()
IDyadRanker	getDyadRanker() Get the dyad ranker used to rank the nodes.
AbstractDyadScaler	getScaler()
boolean	isEmpty()
java.util.Iterator<ai.libs.jaicore.search.model.travesaltree.Node<N,V>>	iterator()
boolean	offer(ai.libs.jaicore.search.model.travesaltree.Node<N,V> e)
ai.libs.jaicore.search.model.travesaltree.Node<N,V>	peek()
ai.libs.jaicore.search.model.travesaltree.Node<N,V>	poll()
ai.libs.jaicore.search.model.travesaltree.Node<N,V>	remove()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
ai.libs.jaicore.search.model.travesaltree.Node<N,V>	removeNodeAtPosition(int i)
boolean	retainAll(java.util.Collection<?> c)
void	setDyadRanker(IDyadRanker dyadRanker) Set which dyad ranker shall be used to rank the nodes.
void	setScaler(AbstractDyadScaler scaler)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

scaler

protected AbstractDyadScaler scaler

for scaling the dyads

Constructor Detail

ADyadRankedNodeQueue

public ADyadRankedNodeQueue(ai.libs.jaicore.math.linearalgebra.Vector contextCharacterization)

Constructs a new DyadRankedNodeQueue that ranks the nodes in the queue according to the given context characterization.

Parameters:

contextCharacterization - the characterization of the context the nodes are ranked in

ADyadRankedNodeQueue

public ADyadRankedNodeQueue(ai.libs.jaicore.math.linearalgebra.Vector contextCharacterization,
                            IDyadRanker dyadRanker,
                            AbstractDyadScaler scaler)

Constructs a new DyadRankedNodeQueue that ranks the nodes in the queue according to the given context characterization and given dyad ranker. Given dyad ranker must be pre-trained.

Parameters:

contextCharacterization - the characterization of the context the nodes are ranked in

dyadRanker - the dyad ranker to be used for the ranking of the nodes

Method Detail

characterize

protected abstract ai.libs.jaicore.math.linearalgebra.Vector characterize(ai.libs.jaicore.search.model.travesaltree.Node<N,V> node)

Provide a characterization of the given node to be used by the dyad ranker.

Parameters:

node - the node to be characterized

Returns:

the characterization of the node

size

public int size()

Specified by:

size in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

iterator

public java.util.Iterator<ai.libs.jaicore.search.model.travesaltree.Node<N,V>> iterator()

Specified by:

iterator in interface java.lang.Iterable<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

Specified by:

iterator in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

addAll

public boolean addAll(java.util.Collection<? extends ai.libs.jaicore.search.model.travesaltree.Node<N,V>> c)

Specified by:

addAll in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

add

public boolean add(ai.libs.jaicore.search.model.travesaltree.Node<N,V> e)

Specified by:

add in interface java.util.Collection<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

Specified by:

add in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

offer

public boolean offer(ai.libs.jaicore.search.model.travesaltree.Node<N,V> e)

Specified by:

offer in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

remove

public ai.libs.jaicore.search.model.travesaltree.Node<N,V> remove()

Specified by:

remove in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

removeNodeAtPosition

public ai.libs.jaicore.search.model.travesaltree.Node<N,V> removeNodeAtPosition(int i)

poll

public ai.libs.jaicore.search.model.travesaltree.Node<N,V> poll()

Specified by:

poll in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

element

public ai.libs.jaicore.search.model.travesaltree.Node<N,V> element()

Specified by:

element in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

peek

public ai.libs.jaicore.search.model.travesaltree.Node<N,V> peek()

Specified by:

peek in interface java.util.Queue<ai.libs.jaicore.search.model.travesaltree.Node<N,V extends java.lang.Comparable<V>>>

getDyadRanker

public IDyadRanker getDyadRanker()

Get the dyad ranker used to rank the nodes.

Returns:

the dyad ranker

setDyadRanker

public void setDyadRanker(IDyadRanker dyadRanker)

Set which dyad ranker shall be used to rank the nodes. It is not trained in this class, so it must be pre-trained before setting it as a dyad ranker for this queue!

Parameters:

dyadRanker - the dyad ranker

getScaler

public AbstractDyadScaler getScaler()

setScaler

public void setScaler(AbstractDyadScaler scaler)