Package org.opennars.main

Class Nar

java.lang.Object

org.opennars.plugin.perception.SensoryChannel

org.opennars.main.Nar

All Implemented Interfaces:

Serializable, Runnable, Eventable, InputFileConsumer, Multistepable, NarseseConsumer, Pluggable, Reasoner, Resettable, SensoryChannelConsumer, TaskConsumer<Reasoner>, Timable, Plugin

public class Nar
extends SensoryChannel
implements Reasoner, Serializable, Runnable

Non-Axiomatic Reasoner Instances of this represent a reasoner connected to a Memory, and set of Input and Output channels. All state is contained within Memory. A Nar is responsible for managing I/O channels and executing memory operations. It executesa series sof cycles in two possible modes: * step mode - controlled by an outside system, such as during debugging or testing * thread mode - runs in a pausable closed-loop at a specific maximum framerate.

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Nar.PluginState

Field Summary

Fields

Modifier and Type	Field	Description
private Long	cycle
static String	DEFAULTCONFIG_FILEPATH
Memory	memory	The memory of the reasoner
(package private) long	minCyclePeriodMS
protected String	name	The name of the reasoner
static String	NAME	Name of the reasoner of the project
Parameters	narParameters
protected List<Nar.PluginState>	plugins
private boolean	running	Flag for running continuously
protected Map<Term,SensoryChannel>	sensoryChannels
private boolean	stopped	used by stop() to signal that a running loop should be interrupted
private Thread[]	threads
private boolean	threadYield
String	usedConfigFilePath
static String	VERSION	The information about the version of the project
static String	WEBSITE	The project web sites.

Fields inherited from class org.opennars.plugin.perception.SensoryChannel

duration, height, nar, results, width

Constructor Summary

Constructors

Constructor	Description
Nar()	constructs the NAR and loads a config from the default filepath Assigns a random id to the instance
Nar(long narId)	constructs the NAR and loads a config from the default filepath
Nar(long narId, String relativeConfigFilePath)	constructs the NAR and loads a config from the filepath
Nar(long narId, String relativeConfigFilePath, Map<String,Object> parameterOverrides)	constructs the NAR and loads a config from the filepath
Nar(String relativeConfigFilePath)	constructs the NAR and loads a config from the filepath
Nar(String relativeConfigFilePath, Map<String,Object> parameterOverrides)	constructs the NAR and loads a config from the filepath
Nar(Map<String,Object> parameterOverrides)	constructs the NAR and loads a config from the default filepath Assigns a random id to the instance

Method Summary

Modifier and Type	Method	Description
private boolean	addCommand(String text)
void	addInput(String text)	feeds narsese input to the consumer
Nar	addInput(Task t, Timable time)	consumes a task
void	addInputFile(String s)	consumes a file
private boolean	addMultiLineInput(String text)	Generally the text will consist of Task's to be parsed in Narsese, but may contain other commands recognized by the system.
void	addPlugin(Plugin p)	adds/registers a plugin
void	addSensoryChannel(String term, SensoryChannel channel)	registers a sensory channel by/for the term
Nar	ask(String termString, AnswerHandler answered)	ask reasoner a eternal question
Nar	askNow(String termString, AnswerHandler answered)	ask reasoner a now question
Concept	concept(String concept)	gets a concept if it exists, or returns null if it does not
void	cycle()	A frame, consisting of one or more Nar memory cycles
void	cycles(int cycles)	Execute a fixed number of cycles.
private boolean	dispatchToSensoryChannel(Task task)	dispatches the task to the sensory channel if necessary
void	emit(Class c, Object... o)
void	event(EventEmitter.EventObserver e, boolean enabled, Class... events)	set an event handler.
long	getMinCyclePeriodMS()	returns the minimum delay of a cycle in milliseconds
List<Nar.PluginState>	getPlugins()	returns all plugins which were added
boolean	isRunning()	is the reasoner running?
static Nar	LoadFromFile(String name)
void	off(Class c, EventEmitter.EventObserver o)	remove event handler
void	on(Class c, EventEmitter.EventObserver o)	attach event handler
private static void	overrideParameters(Parameters parameters, Map<String,Object> overrides)	overrides parameter values by name
void	removePlugin(Nar.PluginState ps)	removes a plugin
void	reset()	Reset the system with an empty memory and reset clock.
void	run()	Main loop executed by the Thread.
void	SaveToFile(String name)
void	setThreadYield(boolean b)	When b is true, Nar will call Thread.yield each run() iteration that minCyclePeriodMS==0 (no delay).
void	start()
void	start(long minCyclePeriodMS)
void	stop()	Stop the inference process, killing its thread.
long	time()	return the current time from the clock
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennars.plugin.Plugin

name, setEnabled

Methods inherited from class org.opennars.plugin.perception.SensoryChannel

addInput, getDuration, getHeight, getName, getWidth, priority, resetChannel, setDuration, setHeight, setName, setWidth, step_finished, step_start, topDownPriority

Field Detail

narParameters

public Parameters narParameters

cycle

private Long cycle

VERSION

public static final String VERSION

The information about the version of the project

See Also:

Constant Field Values

NAME

public static final String NAME

Name of the reasoner of the project

See Also:

Constant Field Values

WEBSITE

public static final String WEBSITE

The project web sites.

See Also:

Constant Field Values

threads

private transient Thread[] threads

sensoryChannels

protected transient Map<Term,SensoryChannel> sensoryChannels

minCyclePeriodMS

volatile long minCyclePeriodMS

name

protected String name

The name of the reasoner

memory

public final Memory memory

The memory of the reasoner

plugins

protected transient List<Nar.PluginState> plugins

running

private transient boolean running

Flag for running continuously

stopped

private transient boolean stopped

used by stop() to signal that a running loop should be interrupted

threadYield

private transient boolean threadYield

DEFAULTCONFIG_FILEPATH

public static final String DEFAULTCONFIG_FILEPATH

See Also:

Constant Field Values

usedConfigFilePath

public String usedConfigFilePath

Constructor Detail

Nar

public Nar(long narId)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           IllegalAccessException,
           SAXException,
           ClassNotFoundException,
           ParseException

constructs the NAR and loads a config from the default filepath

Parameters:

narId - inter NARS id of this NARS instance

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

IllegalAccessException

SAXException

ClassNotFoundException

ParseException

Nar

public Nar(long narId,
           String relativeConfigFilePath)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           SAXException,
           IllegalAccessException,
           ParseException,
           ClassNotFoundException

constructs the NAR and loads a config from the filepath

Parameters:

narId - inter NARS id of this NARS instance

relativeConfigFilePath - (relative) path of the XML encoded config file

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

SAXException

IllegalAccessException

ParseException

ClassNotFoundException

Nar

public Nar(long narId,
           String relativeConfigFilePath,
           Map<String,Object> parameterOverrides)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           SAXException,
           IllegalAccessException,
           ParseException,
           ClassNotFoundException

constructs the NAR and loads a config from the filepath

Parameters:

narId - inter NARS id of this NARS instance

relativeConfigFilePath - (relative) path of the XML encoded config file

parameterOverrides - (overwritten) parameters of a Reasoner

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

SAXException

IllegalAccessException

ParseException

ClassNotFoundException

Nar

public Nar(String relativeConfigFilePath)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           SAXException,
           IllegalAccessException,
           ParseException,
           ClassNotFoundException

constructs the NAR and loads a config from the filepath

Parameters:

relativeConfigFilePath - (relative) path of the XML encoded config file

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

SAXException

IllegalAccessException

ParseException

ClassNotFoundException

Nar

public Nar(String relativeConfigFilePath,
           Map<String,Object> parameterOverrides)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           SAXException,
           IllegalAccessException,
           ParseException,
           ClassNotFoundException

constructs the NAR and loads a config from the filepath

Parameters:

relativeConfigFilePath - (relative) path of the XML encoded config file

parameterOverrides - (overwritten) parameters of a Reasoner

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

SAXException

IllegalAccessException

ParseException

ClassNotFoundException

Nar

public Nar()
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           IllegalAccessException,
           SAXException,
           ClassNotFoundException,
           ParseException

constructs the NAR and loads a config from the default filepath Assigns a random id to the instance

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

IllegalAccessException

SAXException

ClassNotFoundException

ParseException

Nar

public Nar(Map<String,Object> parameterOverrides)
    throws IOException,
           InstantiationException,
           InvocationTargetException,
           NoSuchMethodException,
           ParserConfigurationException,
           IllegalAccessException,
           SAXException,
           ClassNotFoundException,
           ParseException

constructs the NAR and loads a config from the default filepath Assigns a random id to the instance

Parameters:

parameterOverrides - (overwritten) parameters of a Reasoner

Throws:

IOException

InstantiationException

InvocationTargetException

NoSuchMethodException

ParserConfigurationException

IllegalAccessException

SAXException

ClassNotFoundException

ParseException

Method Detail

addSensoryChannel

public void addSensoryChannel(String term,
                              SensoryChannel channel)

Description copied from interface: SensoryChannelConsumer

registers a sensory channel by/for the term

Specified by:

addSensoryChannel in interface SensoryChannelConsumer

Parameters:

term - term in narsese

channel - the channel to be registered

SaveToFile

public void SaveToFile(String name)
                throws IOException

Throws:

IOException

LoadFromFile

public static Nar LoadFromFile(String name)
                        throws IOException,
                               ClassNotFoundException,
                               IllegalAccessException,
                               ParseException,
                               ParserConfigurationException,
                               SAXException,
                               NoSuchMethodException,
                               InstantiationException,
                               InvocationTargetException

Throws:

IOException

ClassNotFoundException

IllegalAccessException

ParseException

ParserConfigurationException

SAXException

NoSuchMethodException

InstantiationException

InvocationTargetException

reset

public void reset()

Reset the system with an empty memory and reset clock. Called locally.

Specified by:

reset in interface Resettable

addMultiLineInput

private boolean addMultiLineInput(String text)

Generally the text will consist of Task's to be parsed in Narsese, but may contain other commands recognized by the system. The creationTime will be set to the current memory cycle time, but may be processed by memory later according to the length of the input queue.

addCommand

private boolean addCommand(String text)
                    throws IOException

Throws:

IOException

addInput

public void addInput(String text)

Description copied from interface: NarseseConsumer

feeds narsese input to the consumer

Specified by:

addInput in interface NarseseConsumer

Parameters:

text - the narsese text

dispatchToSensoryChannel

private boolean dispatchToSensoryChannel(Task task)

dispatches the task to the sensory channel if necessary

Parameters:

task - dispatched task

Returns:

was it dispatched to a sensory channel?

addInputFile

public void addInputFile(String s)

Description copied from interface: InputFileConsumer

consumes a file

Specified by:

addInputFile in interface InputFileConsumer

Parameters:

s - optional path followed by filename

concept

public Concept concept(String concept)
                throws Parser.InvalidInputException

gets a concept if it exists, or returns null if it does not

Specified by:

concept in interface Reasoner

Parameters:

concept - the name/term of the concept

Returns:

queried or created concept

Throws:

Parser.InvalidInputException

ask

public Nar ask(String termString,
               AnswerHandler answered)
        throws Parser.InvalidInputException

Description copied from interface: Reasoner

ask reasoner a eternal question

Specified by:

ask in interface Reasoner

Parameters:

termString - narsese string with term of question

answered - handler which will be called when answered

Returns:

reasoner which processes the question

Throws:

Parser.InvalidInputException

askNow

public Nar askNow(String termString,
                  AnswerHandler answered)
           throws Parser.InvalidInputException

Description copied from interface: Reasoner

ask reasoner a now question

Specified by:

askNow in interface Reasoner

Parameters:

termString - narsese string with term of question

answered - handler which will be called when answered

Returns:

reasoner which processes the question

Throws:

Parser.InvalidInputException

addInput

public Nar addInput(Task t,
                    Timable time)

Description copied from interface: TaskConsumer

consumes a task

Specified by:

addInput in interface TaskConsumer<Reasoner>

Specified by:

addInput in class SensoryChannel

Parameters:

t - task to be consumed

time - used to retrieve the time

Returns:

something which consumed the task or which was assigned the task

on

public void on(Class c,
               EventEmitter.EventObserver o)

attach event handler

Specified by:

on in interface Eventable

off

public void off(Class c,
                EventEmitter.EventObserver o)

remove event handler

Specified by:

off in interface Eventable

event

public void event(EventEmitter.EventObserver e,
                  boolean enabled,
                  Class... events)

set an event handler. useful for multiple events.

Specified by:

event in interface Eventable

addPlugin

public void addPlugin(Plugin p)

Description copied from interface: Pluggable

adds/registers a plugin

Specified by:

addPlugin in interface Pluggable

Parameters:

p - plugin to be registered

removePlugin

public void removePlugin(Nar.PluginState ps)

Description copied from interface: Pluggable

removes a plugin

Specified by:

removePlugin in interface Pluggable

Parameters:

ps - plugin to be removed

getPlugins

public List<Nar.PluginState> getPlugins()

Description copied from interface: Pluggable

returns all plugins which were added

Specified by:

getPlugins in interface Pluggable

Returns:

plugins

start

public void start(long minCyclePeriodMS)

Specified by:

start in interface Multistepable

start

public void start()

Specified by:

start in interface Multistepable

stop

public void stop()

Stop the inference process, killing its thread.

Specified by:

stop in interface Multistepable

cycles

public void cycles(int cycles)

Execute a fixed number of cycles.

Specified by:

cycles in interface Multistepable

run

public void run()

Main loop executed by the Thread. Should not be called directly.

Specified by:

run in interface Reasoner

Specified by:

run in interface Runnable

emit

public void emit(Class c,
                 Object... o)

Specified by:

emit in interface Eventable

cycle

public void cycle()

A frame, consisting of one or more Nar memory cycles

Specified by:

cycle in interface Multistepable

toString

public String toString()

Overrides:

toString in class Object

time

public long time()

Description copied from interface: Reasoner

return the current time from the clock

Specified by:

time in interface Reasoner

Specified by:

time in interface Timable

Returns:

The current time

isRunning

public boolean isRunning()

Description copied from interface: Reasoner

is the reasoner running?

Specified by:

isRunning in interface Reasoner

Returns:

is it running

getMinCyclePeriodMS

public long getMinCyclePeriodMS()

Description copied from interface: Reasoner

returns the minimum delay of a cycle in milliseconds

Specified by:

getMinCyclePeriodMS in interface Reasoner

Returns:

minimum cycle delay period

setThreadYield

public void setThreadYield(boolean b)

When b is true, Nar will call Thread.yield each run() iteration that minCyclePeriodMS==0 (no delay). This is for improving program responsiveness when Nar is run with no delay.

Specified by:

setThreadYield in interface Reasoner

Parameters:

b - Nar will call Thread.yield each run()

overrideParameters

private static void overrideParameters(Parameters parameters,
                                       Map<String,Object> overrides)

overrides parameter values by name

Parameters:

parameters - (overwritten) parameters of a Reasoner

overrides - specific override values by parameter name