Package jason.stdlib

Class atom

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.atom

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal=".atom(arg)",
        hint="checks whether the argument is an atom (a structure with arity 0)",
        argsHint="the term to be checked",
        argsType="term",
        examples={".atom(b(10)): false",".atom(b): true",".atom(~b): false",".atom(10): false",".atom(\"home page\"): false",".atom(X): only true if X is bound to an atom",".atom(a(X)): false",".atom(a[X]): false",".atom([a,b,c]): false",".atom([a,b,c(X)]): false"},
        seeAlso={"jason.stdlib.atom","jason.stdlib.list","jason.stdlib.literal","jason.stdlib.number","jason.stdlib.string","jason.stdlib.structure","jason.stdlib.ground"})
public class atom
extends DefaultInternalAction

Internal action: .atom.

Description: checks whether the argument is an atom (a structure with arity 0), for example "p". Numbers, strings, and free variables are not atoms.

Parameters:

• + arg (any term): the term to be checked.
  

Examples:

• .atom(b(10)): false.
• .atom(b): true.
• .atom(~b): false.
• .atom(10): false.
• .atom("home page"): false.
• .atom(X): only true if X is bound to an atom.
• .atom(a(X)): false.
• .atom(a[X]): false.
• .atom([a,b,c]): false.
• .atom([a,b,c(X)]): false.

See Also:

• atom
• list
• literal
• number
• string
• structure
• ground
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
atom()

Method Summary

Modifier and Type	Method	Description
static InternalAction	create()
Object	execute(TransitionSystem ts, Unifier un, Term[] args)	Executes the internal action.
int	getMaxArgs()
int	getMinArgs()

Methods inherited from class jason.asSemantics.DefaultInternalAction

canBeUsedInContext, checkArguments, destroy, prepareArguments, suspendIntention

Methods inherited from class java.lang.Object

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

Constructor Details

atom

public atom()

Method Details

create

public static InternalAction create()

getMinArgs

public int getMinArgs()

Overrides:

getMinArgs in class DefaultInternalAction

getMaxArgs

public int getMaxArgs()

Overrides:

getMaxArgs in class DefaultInternalAction

execute

public Object execute(TransitionSystem ts,
 Unifier un,
 Term[] args)
               throws Exception

Description copied from interface: InternalAction

Executes the internal action. It should return a Boolean or an Iterator. A true boolean return means that the IA was successfully executed. An Iterator result means that there is more than one answer for this IA (e.g. see member internal action).

Specified by:

execute in interface InternalAction

Overrides:

execute in class DefaultInternalAction

Throws:

Exception