LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint Class Reference

add a linear equation constraint to the LP. More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint:

Public Member Functions

final IFuzzyValue< Boolean > execute (final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List< ITerm > p_argument, @Nonnull final List< ITerm > p_return)
 defines a plan-body operation More...
 
final int minimalArgumentNumber ()
 minimum number of arguments More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.math.linearprogram.IConstraint
 IConstraint ()
 ctor More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
final IPath name ()
 returns the name with path of the action More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IBaseAction
final boolean equals (final Object p_object)
 
final int hashCode ()
 
final String toString ()
 
- Public Member Functions inherited from org.lightjason.agentspeak.action.IAction
default Stream< IVariable<?> > variables ()
 returns a stream with all used variables More...
 

Static Private Attributes

static final long serialVersionUID = 3123101079239668634L
 serial id More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.action.IAction
long serialVersionUID = -6374480398439703170L
 serial id More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.math.linearprogram.IConstraint
final Relationship getRelation ( @Nonnull final String p_symbol)
 returns the enum of a relationship by a string value More...
 
- Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
 IBuiltinAction ()
 ctor More...
 
 IBuiltinAction (final int p_length)
 ctor More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction
static final Logger LOGGER = CCommon.logger( IBuiltinAction.class )
 logger More...
 
- Static Protected Attributes inherited from org.lightjason.agentspeak.action.IBaseAction
static final Logger LOGGER = org.lightjason.agentspeak.common.CCommon.logger( IAction.class )
 logger More...
 

Detailed Description

The arguments of the action contains the left and right side of the equation:

  • \( \left( \sum_{i=1} c_i \cdot x_i \right) + c_{const} = \left( \sum_{i=1} r_i \cdot x_i \right) + r_{const} \)
  • \( \left( \sum_{i=1} c_i \cdot x_i \right) + c_{const} \geq \left( \sum_{i=1} r_i \cdot x_i \right) + r_{const} \)
  • \( \left( \sum_{i=1} c_i \cdot x_i \right) + c_{const} \leq \left( \sum_{i=1} r_i \cdot x_i \right) + r_{const} \)

The first arguments is the LP object, the following arguments are the \( c_i \) values, after that the \( c_{const} \) value must be added, in the middle of the arguments the relation symbol ( \( = \), \( \geq \) or \( \leq \)) must be set as string, after that all \( r_i \) elements must be set and the last argument is the \( r_{const} \), the action fails on wrong input

math/linearprogram/equationconstraint( LP, [2,7,[7,12,[19]]], "<", [1,2],3,5 );
See also
https://en.wikipedia.org/wiki/Linear_programming
http://commons.apache.org/proper/commons-math/userguide/optimization.html

Definition at line 59 of file CEquationConstraint.java.

Member Function Documentation

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint.execute ( final boolean  p_parallel,
@Nonnull final IContext  p_context,
@Nonnull final List< ITerm p_argument,
@Nonnull final List< ITerm p_return 
)
Parameters
p_parallelparallel execution
p_contextcurrent execution context
p_argumentparameter of the action
p_returnreturn values
Returns
fuzzy boolean

Implements org.lightjason.agentspeak.language.execution.IExecution.

Definition at line 76 of file CEquationConstraint.java.

References org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from(), and org.lightjason.agentspeak.action.builtin.math.linearprogram.IConstraint.getRelation().

Referenced by org.lightjason.agentspeak.action.builtin.TestCActionMathLinearprogram.equationconstraint().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ minimalArgumentNumber()

final int org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint.minimalArgumentNumber ( )
Returns
number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 69 of file CEquationConstraint.java.

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.math.linearprogram.CEquationConstraint.serialVersionUID = 3123101079239668634L
staticprivate

Definition at line 64 of file CEquationConstraint.java.