Package network.aika.neuron.relation

Class Relation

java.lang.Object

network.aika.neuron.relation.Relation

All Implemented Interfaces:

java.lang.Comparable<Relation>, Writable

Direct Known Subclasses:

AncestorRelation, MultiRelation, PositionRelation, Relation.Any

public abstract class Relation
extends java.lang.Object
implements java.lang.Comparable<Relation>, Writable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Relation.Any
static class	Relation.Builder
static interface	Relation.RelationFactory

Field Summary

Fields

Modifier and Type	Field	Description
static Relation	AFTER
static Relation	ANY
static Relation	BEFORE
static Relation	BEGIN_EQUALS
static Relation	BEGIN_TO_END_EQUALS
static Relation	CONTAINED_IN
static Relation	CONTAINS
static Relation	END_EQUALS
static Relation	END_TO_BEGIN_EQUALS
static Relation	EQUALS
protected boolean	follow
protected boolean	optional
static Relation	OVERLAPS
static java.util.Map<java.lang.Integer,Relation.RelationFactory>	relationRegistry

Constructor Summary

Constructors

Constructor	Description
Relation()
Relation(boolean optional, boolean follow)

Method Summary

Modifier and Type	Method	Description
static void	addRelation(java.util.Map<java.lang.Integer,Relation> relMap, java.lang.Integer synId, java.lang.Integer targetSynId, Neuron n, Relation r)
int	compareTo(Relation rel)
abstract java.util.stream.Stream<Activation>	getActivations(INeuron n, Activation linkedAct)
static java.util.Map<java.lang.Integer,Relation>	getRelationsMap(int synapseId, Neuron n)
abstract int	getType()
abstract Relation	invert()
boolean	isConvertible()
abstract boolean	isExact()
boolean	isFollow()
boolean	isOptional()
abstract void	linksOutputs(java.util.Set<java.lang.Integer> outputs)
abstract void	mapSlots(java.util.Map<java.lang.Integer,Position> slots, Activation act)
static Relation	read(java.io.DataInput in, Model m)
void	readFields(java.io.DataInput in, Model m)	Deserialize the fields of this object from in.
static void	registerRelation(int relationType, Relation.RelationFactory rf)
abstract void	registerRequiredSlots(Neuron input)
abstract Relation	setOptionalAndFollow(boolean optional, boolean follow)
abstract boolean	test(Activation act, Activation linkedAct)
void	write(java.io.DataOutput out)	Serialize the fields of this object to out.

Methods inherited from class java.lang.Object

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

Field Detail

relationRegistry

public static java.util.Map<java.lang.Integer,Relation.RelationFactory> relationRegistry

EQUALS

public static Relation EQUALS

BEGIN_EQUALS

public static Relation BEGIN_EQUALS

END_EQUALS

public static Relation END_EQUALS

BEGIN_TO_END_EQUALS

public static Relation BEGIN_TO_END_EQUALS

END_TO_BEGIN_EQUALS

public static Relation END_TO_BEGIN_EQUALS

CONTAINS

public static Relation CONTAINS

CONTAINED_IN

public static Relation CONTAINED_IN

OVERLAPS

public static Relation OVERLAPS

BEFORE

public static Relation BEFORE

AFTER

public static Relation AFTER

ANY

public static Relation ANY

optional

protected boolean optional

follow

protected boolean follow

Constructor Detail

Relation

public Relation()

Relation

public Relation(boolean optional,
                boolean follow)

Method Detail

isOptional

public boolean isOptional()

isFollow

public boolean isFollow()

compareTo

public int compareTo(Relation rel)

Specified by:

compareTo in interface java.lang.Comparable<Relation>

registerRelation

public static void registerRelation(int relationType,
                                    Relation.RelationFactory rf)

getType

public abstract int getType()

test

public abstract boolean test(Activation act,
                             Activation linkedAct)

invert

public abstract Relation invert()

mapSlots

public abstract void mapSlots(java.util.Map<java.lang.Integer,Position> slots,
                              Activation act)

linksOutputs

public abstract void linksOutputs(java.util.Set<java.lang.Integer> outputs)

setOptionalAndFollow

public abstract Relation setOptionalAndFollow(boolean optional,
                                              boolean follow)

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

java.io.IOException

read

public static Relation read(java.io.DataInput in,
                            Model m)
                     throws java.io.IOException

Throws:

java.io.IOException

readFields

public void readFields(java.io.DataInput in,
                       Model m)
                throws java.io.IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

java.io.IOException

isExact

public abstract boolean isExact()

getActivations

public abstract java.util.stream.Stream<Activation> getActivations(INeuron n,
                                                                   Activation linkedAct)

isConvertible

public boolean isConvertible()

addRelation

public static void addRelation(java.util.Map<java.lang.Integer,Relation> relMap,
                               java.lang.Integer synId,
                               java.lang.Integer targetSynId,
                               Neuron n,
                               Relation r)

getRelationsMap

public static java.util.Map<java.lang.Integer,Relation> getRelationsMap(int synapseId,
                                                                              Neuron n)

registerRequiredSlots

public abstract void registerRequiredSlots(Neuron input)