gov.sandia.cognition.learning.algorithm.ensemble

Class WeightedAveragingEnsemble<InputType,MemberType extends Evaluator<? super InputType,? extends java.lang.Number>>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.algorithm.ensemble.AbstractWeightedEnsemble<MemberType>

gov.sandia.cognition.learning.algorithm.ensemble.WeightedAveragingEnsemble<InputType,MemberType>

Type Parameters:

InputType - The type of input the ensemble can take. Passed to each ensemble member to produce an output.

MemberType - The type of members of this ensemble.

All Implemented Interfaces:

Evaluator<InputType,java.lang.Double>, Ensemble<WeightedValue<MemberType>>, Regressor<InputType>, ScalarFunction<InputType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class WeightedAveragingEnsemble<InputType,MemberType extends Evaluator<? super InputType,? extends java.lang.Number>>
extends AbstractWeightedEnsemble<MemberType>
implements Regressor<InputType>

An implementation of an ensemble that takes the weighted average of its members. The weights must be non-negative.

Since:

3.3.3

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.sandia.cognition.learning.algorithm.ensemble.AbstractWeightedEnsemble

DEFAULT_WEIGHT, members

Constructor Summary

Constructors

Constructor and Description
WeightedAveragingEnsemble() Creates a new, empty of WeightedAveragingEnsemble.
WeightedAveragingEnsemble(java.util.List<WeightedValue<MemberType>> members) Creates a new instance of WeightedAveragingEnsemble.

Method Summary

Modifier and Type	Method and Description
void	add(MemberType member, double weight) Adds the given regression function with a given weight.
java.lang.Double	evaluate(InputType input) Returns the result of calling evaluateAsDouble.
double	evaluateAsDouble(InputType input) Evaluates the scalar function as a double.

Methods inherited from class gov.sandia.cognition.learning.algorithm.ensemble.AbstractWeightedEnsemble

add, clone, getMemberCount, getMembers, getWeightSum, setMembers

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedAveragingEnsemble

public WeightedAveragingEnsemble()

Creates a new, empty of WeightedAveragingEnsemble.

WeightedAveragingEnsemble

public WeightedAveragingEnsemble(java.util.List<WeightedValue<MemberType>> members)

Creates a new instance of WeightedAveragingEnsemble.

Parameters:

members - The members of the ensemble.

Method Detail

add

public void add(MemberType member,
                double weight)

Description copied from class: AbstractWeightedEnsemble

Adds the given regression function with a given weight.

Overrides:

add in class AbstractWeightedEnsemble<MemberType extends Evaluator<? super InputType,? extends java.lang.Number>>

Parameters:

member - The regression function to add.

weight - The weight for the new member.

evaluate

public java.lang.Double evaluate(InputType input)

Description copied from interface: ScalarFunction

Returns the result of calling evaluateAsDouble.

Specified by:

evaluate in interface Evaluator<InputType,java.lang.Double>

Specified by:

evaluate in interface ScalarFunction<InputType>

Parameters:

input - The input value.

Returns:

The result evaluated as a double.

evaluateAsDouble

public double evaluateAsDouble(InputType input)

Description copied from interface: ScalarFunction

Evaluates the scalar function as a double.

Specified by:

evaluateAsDouble in interface ScalarFunction<InputType>

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.