action for harmonic mean. More...

Inheritance diagram for org.lightjason.agentspeak.action.builtin.math.CHarmonicMean:

Collaboration diagram for org.lightjason.agentspeak.action.builtin.math.CHarmonicMean:

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.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 Member Functions
static double	apply (final double p_count, final Stream< Double > p_values)
	calculate harmonic mean More...

Static Private Attributes
static final long	serialVersionUID = 512098153369001644L
	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.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 action calculates \( \frac{i}{\sum_{i} \frac{1}{x_i}} \) over all unflatten arguments, action fails never

G = math/harmonicmean( 1, 3, 9, [10, [11, 12]] );

See also: https://en.wikipedia.org/wiki/Average

Definition at line 48 of file CHarmonicMean.java.

Member Function Documentation

◆ apply()

static double org.lightjason.agentspeak.action.builtin.math.CHarmonicMean.apply	(	final double	p_count,
		final Stream< Double >	p_values
	)

staticprivate

Parameters

p_count	number of elements
p_values	value stream

Returns: harmonic mean

Definition at line 90 of file CHarmonicMean.java.

Referenced by org.lightjason.agentspeak.action.builtin.math.CHarmonicMean.execute().

Here is the caller graph for this function:

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.math.CHarmonicMean.execute	(	final boolean	p_parallel,
		@Nonnull final IContext	p_context,
		@Nonnull final List< ITerm >	p_argument,
		@Nonnull final List< ITerm >	p_return
	)

Parameters

p_parallel	parallel execution
p_context	current execution context
p_argument	parameter of the action
p_return	return values

Returns: fuzzy boolean

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

Definition at line 64 of file CHarmonicMean.java.

References org.lightjason.agentspeak.action.builtin.math.CHarmonicMean.apply(), org.lightjason.agentspeak.language.CCommon.flatten(), org.lightjason.agentspeak.language.CRawTerm< T >.from(), and org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from().

Referenced by org.lightjason.agentspeak.action.builtin.TestCActionMath.harmonicmean().

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.CHarmonicMean.minimalArgumentNumber ( )

Returns: number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 57 of file CHarmonicMean.java.

Member Data Documentation

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.math.CHarmonicMean.serialVersionUID = 512098153369001644L

staticprivate

Definition at line 53 of file CHarmonicMean.java.

Public Member Functions

Static Private Member Functions

Static Private Attributes