org.opentrafficsim.kpi.sampling.data.ExtendedDataFloat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ots-kpi Show documentation
OpenTrafficSim KPI Module without dependencies to ots-road or ots-core
There is a newer version: 1.7.5
package org.opentrafficsim.kpi.sampling.data;

import java.util.Arrays;

import org.djunits.unit.Unit;
import org.djunits.value.ValueRuntimeException;
import org.djunits.value.vfloat.scalar.base.AbstractFloatScalar;
import org.djunits.value.vfloat.vector.base.AbstractFloatVector;
import org.djutils.exceptions.Throw;
import org.opentrafficsim.kpi.interfaces.GtuData;
import org.opentrafficsim.kpi.sampling.SamplingException;

/**
 * Class to facilitate JUNITS types in extended data.
 * 
 * Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. 

 * BSD-style license. See OpenTrafficSim License.
 * 
 * @author Alexander Verbraeck
 * @author Peter Knoppers
 * @author Wouter Schakel
 * @param  unit
 * @param  type in vector
 * @param  vector type
 * @param  gtu data type
 */
public abstract class ExtendedDataFloat, T extends AbstractFloatScalar,
        O extends AbstractFloatVector, G extends GtuData> extends ExtendedDataType
{
    /**
     * Constructor setting the id.
     * @param id String; id
     * @param description String; description
     * @param type Class<T>; type class
     */
    public ExtendedDataFloat(final String id, final String description, final Class type)
    {
        super(id, description, type);
    }

    /** {@inheritDoc} */
    @Override
    public final float[] setValue(final float[] storage, final int i, final T value)
    {
        float[] out;
        if (i == storage.length)
        {
            int cap = (i - 1) + ((i - 1) >> 1);
            out = Arrays.copyOf(storage, cap);
        }
        else
        {
            out = storage;
        }
        out[i] = value.si;
        return out;
    }

    /** {@inheritDoc} */
    @Override
    public final float[] initializeStorage()
    {
        return new float[10];
    }

    /** {@inheritDoc} */
    @Override
    public final T getOutputValue(final O output, final int i) throws SamplingException
    {
        try
        {
            return output.get(i);
        }
        catch (ValueRuntimeException exception)
        {
            throw new SamplingException("Index out of range.", exception);
        }
    }

    /** {@inheritDoc} */
    @Override
    public T getStorageValue(final float[] storage, final int i) throws SamplingException
    {
        Throw.when(i < 0 || i >= storage.length, SamplingException.class, "Index %d out of range.", i);
        return convertValue(storage[i]);
    }

    /**
     * Convert float to typed value.
     * @param value float; float value
     * @return typed value
     */
    protected abstract T convertValue(float value);

    /** {@inheritDoc} */
    @Override
    public O convert(final float[] storage, final int size)
    {
        try
        {
            // cut array to size and delegate
            return convert(Arrays.copyOf(storage, size));
        }
        catch (ValueRuntimeException exception)
        {
            throw new RuntimeException("Could not create typed vector from float array.", exception);
        }
    }

    /**
     * Convert float array to typed array.
     * @param storage float[]; float array storage
     * @return typed array
     * @throws ValueRuntimeException when float array cannot be converted
     */
    protected abstract O convert(float[] storage) throws ValueRuntimeException;

}