Package jason.stdlib

Class shuffle

java.lang.Object

jason.asSemantics.DefaultInternalAction

jason.stdlib.shuffle

All Implemented Interfaces:

InternalAction, Serializable

@Manual(literal=".shuffle(list,result)",
        hint="shuffle the elements of the given list",
        argsHint={"the list to be shuffled","the resulting list with the elements shuffled"},
        argsType={"list","list"},
        examples=".shuffle([a,b,c],L): unify in L some random order from input list, e.g., [b,c,a] and [a,b,c]",
        seeAlso={"jason.stdlib.concat","jason.stdlib.delete","jason.stdlib.length","jason.stdlib.member","jason.stdlib.sort","jason.stdlib.substring","jason.stdlib.nth","jason.stdlib.max","jason.stdlib.min","jason.stdlib.reverse","jason.stdlib.difference","jason.stdlib.intersection","jason.stdlib.union"})
public class shuffle
extends DefaultInternalAction

Internal action: .shuffle(List,Result).

Description: shuffle the elements of the List and unifies the result in Var.

Parameters:

• + input (list): the list to be shuffled
  
• - result (list): the list with the elements shuffled.
  

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
shuffle()

Method Summary

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

Methods inherited from class jason.asSemantics.DefaultInternalAction

canBeUsedInContext, destroy, prepareArguments, suspendIntention

Methods inherited from class java.lang.Object

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

Constructor Details

shuffle

public shuffle()

Method Details

getMinArgs

public int getMinArgs()

Overrides:

getMinArgs in class DefaultInternalAction

getMaxArgs

public int getMaxArgs()

Overrides:

getMaxArgs in class DefaultInternalAction

checkArguments

protected void checkArguments(Term[] args)
                       throws JasonException

Overrides:

checkArguments in class DefaultInternalAction

Throws:

JasonException

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