nz.org.riskscape.engine.rl.agg.ModeAggregationFunction

All Implemented Interfaces:: nz.org.riskscape.engine.rl.agg.AggregationFunction

public class ModeAggregationFunction extends ListCollecting

AggregationFunction to find the mode(most observed value).

Should there be many values that qualify as most observed then one of them will be returned as the mode.

Nested Class Summary

Nested classes/interfaces inherited from class nz.org.riskscape.engine.rl.agg.ListCollecting
ListCollecting.ListProcessor, ListCollecting.LocalProblems
Constructor Summary

Constructors

Constructor

Description

ModeAggregationFunction()
Method Summary

Modifier and Type

Method

Description

protected ListCollecting.ListProcessor

buildProcessor(nz.org.riskscape.engine.types.RSList listType, nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.engine.types.Type inputType, nz.org.riskscape.rl.ast.FunctionCall fc)

Build a ListCollecting.ListProcessor that can produce the aggregated result.

Methods inherited from class nz.org.riskscape.engine.rl.agg.ListCollecting
realize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nz.org.riskscape.engine.rl.agg.AggregationFunction
getArguments, getReturnType

Constructor Details
- ModeAggregationFunction
  
  public ModeAggregationFunction()
Method Details
- buildProcessor
  
  protected ListCollecting.ListProcessor buildProcessor(nz.org.riskscape.engine.types.RSList listType, nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.engine.types.Type inputType, nz.org.riskscape.rl.ast.FunctionCall fc) throws nz.org.riskscape.problem.ProblemException
  
  Description copied from class: ListCollecting
  
  Build a ListCollecting.ListProcessor that can produce the aggregated result.
  
  Specified by:
  
  buildProcessor in class ListCollecting
  
  Parameters:
  
  listType - type of the list that will be passed to built processor
  
  context - context to realize any other expressions with
  
  Returns:
  
  list processor to capable of producing aggregated result
  
  Throws:
  
  nz.org.riskscape.problem.ProblemException - with any problems encountered

Class ModeAggregationFunction

Nested Class Summary