MaxArrayFunction.Float

java.lang.Object
- microsim.statistics.functions.AbstractFunction
- - microsim.statistics.functions.AbstractArrayFunction
  - - microsim.statistics.functions.MaxArrayFunction
    - - microsim.statistics.functions.MaxArrayFunction.Float

All Implemented Interfaces:

EventListener, IDoubleSource, IFloatSource, IUpdatableSource

Enclosing class:

MaxArrayFunction
```
public static class MaxArrayFunction.Float
extends MaxArrayFunction
implements IFloatSource
```
MaxFunction operating on float source values.
Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa and Ross Richardson

Nested Class Summary
- Nested classes/interfaces inherited from class microsim.statistics.functions.MaxArrayFunction
  MaxArrayFunction.Double, MaxArrayFunction.Float, MaxArrayFunction.Integer, MaxArrayFunction.Long
- Nested classes/interfaces inherited from interface microsim.statistics.IDoubleSource
  IDoubleSource.Variables
- Nested classes/interfaces inherited from interface microsim.statistics.IFloatSource
  IFloatSource.Variables

Constructor Summary

Constructors
Constructor Description

Float(IFloatArraySource source)
Create a maximum function on an float array source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(float[] data)`	Apply the function on a the given array of float values.
`double`	`getDoubleValue(java.lang.Enum<?> variableID)`	Return the double value corresponding to the given variableID
`float`	`getFloatValue(java.lang.Enum<?> id)`	Return the float value corresponding to the given variableID

Methods inherited from class microsim.statistics.functions.AbstractArrayFunction
apply, apply, apply, applyFunction

Methods inherited from class microsim.statistics.functions.AbstractFunction
isCheckingTime, onEvent, setCheckingTime, updateSource

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

- Constructor Detail
  - Float
```
public Float(IFloatArraySource source)
```
    Create a maximum function on an float array source.
    
    Parameters:
    
    source - The data source.
- Method Detail
  - apply
```
public void apply(float[] data)
```
    Description copied from class: AbstractArrayFunction
    
    Apply the function on a the given array of float values.
    
    Overrides:
    
    apply in class AbstractArrayFunction
    
    Parameters:
    
    data - A source array of values.
  - getFloatValue
```
public float getFloatValue(java.lang.Enum<?> id)
```
    Description copied from interface: IFloatSource
    
    Return the float value corresponding to the given variableID
    
    Specified by:
    
    getFloatValue in interface IFloatSource
    
    Parameters:
    
    id - A unique identifier for a variable.
    
    Returns:
    
    The current float value of the required variable.
  - getDoubleValue
```
public double getDoubleValue(java.lang.Enum<?> variableID)
```
    Description copied from interface: IDoubleSource
    
    Return the double value corresponding to the given variableID
    
    Specified by:
    
    getDoubleValue in interface IDoubleSource
    
    Parameters:
    
    variableID - A unique identifier for a variable.
    
    Returns:
    
    The current double value of the required variable.