MutableFloatVector (DJUNITS 1.02.01 API)

java.lang.Object
- org.djunits.value.AbstractValue
- - org.djunits.value.vfloat.vector.FloatVector
 - - org.djunits.value.vfloat.vector.MutableFloatVector

Type Parameters:

U - Unit; the unit of this MutableFloatVector

All Implemented Interfaces:

Serializable, Value, FloatVectorInterface, MutableFloatVectorInterface

Direct Known Subclasses:

MutableFloatVector.Abs, MutableFloatVector.Rel
```
public abstract class MutableFloatVector>
extends FloatVector
implements MutableFloatVectorInterface
```
MutableFloatVector.
This file was generated by the djunits value classes generator, 26 jun, 2015
Copyright (c) 2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-10-07 11:49:36 +0200 (Wed, 07 Oct 2015) $, @version $Revision: 92 $, by $Author: averbraeck $, initial version 30 Oct, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MutableFloatVector.Abs>

static class MutableFloatVector.Rel>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MutableFloatVector.Abs<U extends Unit<U>>`
`static class`	`MutableFloatVector.Rel<U extends Unit<U>>`

Field Summary
- Fields inherited from class org.djunits.value.vfloat.vector.FloatVector
  data

Constructor Summary

Constructors
Modifier Constructor and Description

protected MutableFloatVector(U unit)
Construct a new MutableFloatVector.

Constructors
Modifier	Constructor and Description
`protected`	`MutableFloatVector(U unit)` Construct a new MutableFloatVector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assign(FloatFunction floatFunction)` Execute a function on a cell by cell basis.
`protected void`	`checkCopyOnWrite()` Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.
`protected MutableFloatVector<U>`	`decrementByImpl(FloatVector.Rel<U> rel)` Decrement the corresponding values of this Relative FloatVector from the values of this MutableFloatVector.
`protected MutableFloatVector<U>`	`incrementByImpl(FloatVector.Rel<U> rel)` Increment the values in this MutableFloatVector by the corresponding values in a Relative FloatVector.
`void`	`normalize()` Normalize the vector, i.e.
`protected MutableFloatVector<U>`	`scaleValueByValue(float[] factor)` Scale the values in this MutableFloatVector by the corresponding values in a float array.
`protected void`	`scaleValueByValue(FloatVector<?> factor)` Scale the values in this MutableFloatVector by the corresponding values in a FloatVector.
`void`	`set(int index, FloatScalar<U> value)` Replace the value at index by the supplied value which is in a compatible unit.
`void`	`setInUnit(int index, float value, U valueUnit)` Replace the value at index by the supplied value which is expressed in a supplied (compatible) unit.
`void`	`setSI(int index, float valueSI)` Replace the value at index by the supplied value which is expressed in the standard SI unit.

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector
cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, initializeSparse, initializeSparseMA, initializeSparseMR, safeGet, safeSet, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

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

Methods inherited from interface org.djunits.value.vfloat.vector.MutableFloatVectorInterface
copy, immutable, toDense, toSparse

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface
cardinality, get, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, mutable, size, toString, toString, toString, toString, zSum

- Constructor Detail
 - MutableFloatVector
```
protected MutableFloatVector(U unit)
```
 Construct a new MutableFloatVector.
 
 Parameters:
 
 unit - U; the unit of the new MutableFloatVector
- Method Detail
 - checkCopyOnWrite
```
protected final void checkCopyOnWrite()
```
 Check the copyOnWrite flag and, if it is set, make a deep copy of the data and clear the flag.
 - setSI
```
public final void setSI(int index,
 float valueSI)
 throws ValueException
```
 Replace the value at index by the supplied value which is expressed in the standard SI unit.
 
 Specified by:
 
 setSI in interface MutableFloatVectorInterface>
 
 Parameters:
 
 index - int; index of the value to replace
 
 valueSI - float; the value to store (expressed in the standard SI unit)
 
 Throws:
 
 ValueException - when index out of range (index < 0 or index >= size())
 - set
```
public final void set(int index,
 FloatScalar value)
 throws ValueException
```
 Replace the value at index by the supplied value which is in a compatible unit.
 
 Specified by:
 
 set in interface MutableFloatVectorInterface>
 
 Parameters:
 
 index - int; index of the value to replace
 
 value - FloatScalar; the strongly typed value to store
 
 Throws:
 
 ValueException - when index out of range (index < 0 or index >= size())
 - setInUnit
```
public final void setInUnit(int index,
 float value,
 U valueUnit)
 throws ValueException
```
 Replace the value at index by the supplied value which is expressed in a supplied (compatible) unit.
 
 Specified by:
 
 setInUnit in interface MutableFloatVectorInterface>
 
 Parameters:
 
 index - int; index of the value to replace
 
 value - float; the value to store (which is expressed in valueUnit)
 
 valueUnit - U; unit of the supplied value
 
 Throws:
 
 ValueException - when index out of range (index < 0 or index >= size())
 - assign
```
public final void assign(FloatFunction floatFunction)
```
 Execute a function on a cell by cell basis. Note: because many functions have to act on zero cells or can generate cells with a zero value, the functions have to be applied on a dense dataset which has to be transformed back to a dense dataset if necessary.
 
 Parameters:
 
 floatFunction - the function to apply
 - incrementByImpl
```
protected final MutableFloatVector incrementByImpl(FloatVector.Rel rel)
 throws ValueException
```
 Increment the values in this MutableFloatVector by the corresponding values in a Relative FloatVector.
 Only Relative values are allowed; adding an Absolute value to an Absolute value is not allowed. Adding an Absolute value to an existing Relative value would require the result to become Absolute, which is a type change that is impossible. For that operation use a static method.
 
 Parameters:
 
 rel - FloatVector.Rel; the Relative FloatVector
 
 Returns:
 
 MutableFloatVector; this modified MutableFloatVector
 
 Throws:
 
 ValueException - when the vectors do not have the same size
 - decrementByImpl
```
protected final MutableFloatVector decrementByImpl(FloatVector.Rel rel)
 throws ValueException
```
 Decrement the corresponding values of this Relative FloatVector from the values of this MutableFloatVector.
 Only Relative values are allowed; subtracting an Absolute value from a Relative value is not allowed. Subtracting an Absolute value from an existing Absolute value would require the result to become Relative, which is a type change that is impossible. For that operation use a static method.
 
 Parameters:
 
 rel - FloatVector.Rel; the Relative FloatVector
 
 Returns:
 
 MutableFloatVector; this modified MutableFloatVector
 
 Throws:
 
 ValueException - when the vectors do not have the same size
 - scaleValueByValue
```
protected final void scaleValueByValue(FloatVector<?> factor)
 throws ValueException
```
 Scale the values in this MutableFloatVector by the corresponding values in a FloatVector.
 
 Parameters:
 
 factor - FloatVector<?>; contains the values by which to scale the corresponding values in this MutableFloatVector
 
 Throws:
 
 ValueException - when the vectors do not have the same size
 - scaleValueByValue
```
protected final MutableFloatVector scaleValueByValue(float[] factor)
 throws ValueException
```
 Scale the values in this MutableFloatVector by the corresponding values in a float array.
 
 Parameters:
 
 factor - float[]; contains the values by which to scale the corresponding values in this MutableFloatVector
 
 Returns:
 
 MutableFloatVector; this modified MutableFloatVector
 
 Throws:
 
 ValueException - when the vector and the array do not have the same size
 - normalize
```
public final void normalize()
 throws ValueException
```
 Normalize the vector, i.e. scale the values to make the sum equal to 1.
 
 Specified by:
 
 normalize in interface MutableFloatVectorInterface>
 
 Throws:
 
 ValueException - when the sum of the values is zero and normalization is not possible

Class MutableFloatVector<U extends Unit<U>>

Nested Class Summary

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.FloatVector

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

Methods inherited from class org.djunits.value.AbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vfloat.vector.MutableFloatVectorInterface

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

Constructor Detail

MutableFloatVector

Method Detail

checkCopyOnWrite

setSI

set

setInUnit

assign

incrementByImpl

decrementByImpl

scaleValueByValue

scaleValueByValue

normalize