package org.djunits.value.vfloat.matrix;
   
   import java.util.Collection;
   
   import org.djunits.unit.DimensionlessUnit;
   import org.djunits.value.function.DimensionlessFunctions;
   import org.djunits.value.storage.StorageType;
   import org.djunits.value.vfloat.function.FloatMathFunctions;
   import org.djunits.value.vfloat.matrix.base.FloatMatrixRel;
  import org.djunits.value.vfloat.matrix.base.FloatSparseValue;
  import org.djunits.value.vfloat.matrix.data.FloatMatrixData;
  import org.djunits.value.vfloat.scalar.FloatDimensionless;
  import org.djunits.value.vfloat.vector.FloatDimensionlessVector;
  import org.djunits.value.vfloat.vector.data.FloatVectorData;
  
  import jakarta.annotation.Generated;
  
  /**
   * Immutable FloatFloatDimensionlessMatrix, a matrix of values with a DimensionlessUnit.
   * <p>
   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
   * </p>
   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
   */
  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
  public class FloatDimensionlessMatrix
          extends FloatMatrixRel<DimensionlessUnit, FloatDimensionless, FloatDimensionlessVector, FloatDimensionlessMatrix>
          implements DimensionlessFunctions<DimensionlessUnit, FloatDimensionlessMatrix>
  {
      /** */
      private static final long serialVersionUID = 20151109L;
  
      /**
       * Construct a FloatDimensionlessMatrix from an internal data object.
       * @param data FloatMatrixData; the internal data object for the matrix
       * @param displayUnit DimensionlessUnit; the display unit of the matrix data
       */
      public FloatDimensionlessMatrix(final FloatMatrixData data, final DimensionlessUnit displayUnit)
      {
          super(data, displayUnit);
      }
  
      /* CONSTRUCTORS WITH float[][] */
  
      /**
       * Construct a FloatDimensionlessMatrix from a float[][] object. The float values are expressed in the displayUnit, and will
       * be printed using the displayUnit.
       * @param data float[][]; the data for the matrix, expressed in the displayUnit
       * @param displayUnit DimensionlessUnit; the unit of the values in the data array, and display unit when printing
       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
       */
      public FloatDimensionlessMatrix(final float[][] data, final DimensionlessUnit displayUnit, final StorageType storageType)
      {
          this(FloatMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
      }
  
      /**
       * Construct a FloatDimensionlessMatrix from a float[][] object. The float values are expressed in the displayUnit. Assume
       * that the StorageType is DENSE since we offer the data as an array of an array.
       * @param data float[][]; the data for the matrix
       * @param displayUnit DimensionlessUnit; the unit of the values in the data array, and display unit when printing
       */
      public FloatDimensionlessMatrix(final float[][] data, final DimensionlessUnit displayUnit)
      {
          this(data, displayUnit, StorageType.DENSE);
      }
  
      /**
       * Construct a FloatDimensionlessMatrix from a float[][] object with SI-unit values.
       * @param data float[][]; the data for the matrix, in SI units
       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
       */
      public FloatDimensionlessMatrix(final float[][] data, final StorageType storageType)
      {
          this(data, DimensionlessUnit.SI, storageType);
      }
  
      /**
       * Construct a FloatDimensionlessMatrix from a float[][] object with SI-unit values. Assume that the StorageType is DENSE
       * since we offer the data as an array of an array.
       * @param data float[][]; the data for the matrix, in SI units
       */
      public FloatDimensionlessMatrix(final float[][] data)
      {
          this(data, StorageType.DENSE);
      }
  
      /* CONSTRUCTORS WITH Dimensionless[][] */
  
      /**
       * Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless
       * values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit
       * when printing.
       * @param data FloatDimensionless[][]; the data for the matrix
       * @param displayUnit DimensionlessUnit; the display unit of the values when printing
       * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
       */
     public FloatDimensionlessMatrix(final FloatDimensionless[][] data, final DimensionlessUnit displayUnit,
             final StorageType storageType)
     {
         this(FloatMatrixData.instantiate(data, storageType), displayUnit);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless
      * values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit
      * when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.
      * @param data FloatDimensionless[][]; the data for the matrix
      * @param displayUnit DimensionlessUnit; the display unit of the values when printing
      */
     public FloatDimensionlessMatrix(final FloatDimensionless[][] data, final DimensionlessUnit displayUnit)
     {
         this(data, displayUnit, StorageType.DENSE);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless
      * values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units
      * when printing. since we offer the data as an array of an array.
      * @param data FloatDimensionless[][]; the data for the matrix
      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
      */
     public FloatDimensionlessMatrix(final FloatDimensionless[][] data, final StorageType storageType)
     {
         this(data, DimensionlessUnit.SI, storageType);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless
      * values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units
      * when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.
      * @param data FloatDimensionless[][]; the data for the matrix
      */
     public FloatDimensionlessMatrix(final FloatDimensionless[][] data)
     {
         this(data, StorageType.DENSE);
     }
 
     /* CONSTRUCTORS WITH Collection<FloatSparseValue> */
 
     /**
      * Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates
      * the unit in which the values in the collection are expressed, as well as the unit in which they will be printed.
      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
      * @param displayUnit DimensionlessUnit; the display unit of the matrix data, and the unit of the data points
      * @param rows int; the number of rows of the matrix
      * @param cols int; the number of columns of the matrix
      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
      */
     public FloatDimensionlessMatrix(final Collection<FloatSparseValue<DimensionlessUnit, FloatDimensionless>> data,
             final DimensionlessUnit displayUnit, final int rows, final int cols, final StorageType storageType)
     {
         this(FloatMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates
      * the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Assume
      * the storage type is SPARSE, since we offer the data as a collection.
      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
      * @param displayUnit DimensionlessUnit; the display unit of the matrix data, and the unit of the data points
      * @param rows int; the number of rows of the matrix
      * @param cols int; the number of columns of the matrix
      */
     public FloatDimensionlessMatrix(final Collection<FloatSparseValue<DimensionlessUnit, FloatDimensionless>> data,
             final DimensionlessUnit displayUnit, final int rows, final int cols)
     {
         this(data, displayUnit, rows, cols, StorageType.SPARSE);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates
      * the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the
      * SI unit or base unit as the displayUnit.
      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
      * @param rows int; the number of rows of the matrix
      * @param cols int; the number of columns of the matrix
      * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
      */
     public FloatDimensionlessMatrix(final Collection<FloatSparseValue<DimensionlessUnit, FloatDimensionless>> data,
             final int rows, final int cols, final StorageType storageType)
     {
         this(data, DimensionlessUnit.SI, rows, cols, storageType);
     }
 
     /**
      * Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates
      * the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the
      * SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a collection.
      * @param data Collection&lt;FloatSparseValue&gt;; the data for the matrix
      * @param rows int; the number of rows of the matrix
      * @param cols int; the number of columns of the matrix
      */
     public FloatDimensionlessMatrix(final Collection<FloatSparseValue<DimensionlessUnit, FloatDimensionless>> data,
             final int rows, final int cols)
     {
         this(data, DimensionlessUnit.SI, rows, cols, StorageType.SPARSE);
     }
 
     /** {@inheritDoc} */
     @Override
     public Class<FloatDimensionless> getScalarClass()
     {
         return FloatDimensionless.class;
     }
 
     /** {@inheritDoc} */
     @Override
     public Class<FloatDimensionlessVector> getVectorClass()
     {
         return FloatDimensionlessVector.class;
     }
 
     /** {@inheritDoc} */
     @Override
     public FloatDimensionlessMatrix instantiateMatrix(final FloatMatrixData fmd, final DimensionlessUnit displayUnit)
     {
         return new FloatDimensionlessMatrix(fmd, displayUnit);
     }
 
     /** {@inheritDoc} */
     @Override
     public FloatDimensionlessVector instantiateVector(final FloatVectorData fvd, final DimensionlessUnit displayUnit)
     {
         return new FloatDimensionlessVector(fvd, displayUnit);
     }
 
     /** {@inheritDoc} */
     @Override
     public FloatDimensionless instantiateScalarSI(final float valueSI, final DimensionlessUnit displayUnit)
     {
         FloatDimensionless result = FloatDimensionless.instantiateSI(valueSI);
         result.setDisplayUnit(displayUnit);
         return result;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix acos()
     {
         assign(FloatMathFunctions.ACOS);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix asin()
     {
         assign(FloatMathFunctions.ASIN);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix atan()
     {
         assign(FloatMathFunctions.ATAN);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix cbrt()
     {
         assign(FloatMathFunctions.CBRT);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix cos()
     {
         assign(FloatMathFunctions.COS);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix cosh()
     {
         assign(FloatMathFunctions.COSH);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix exp()
     {
         assign(FloatMathFunctions.EXP);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix expm1()
     {
         assign(FloatMathFunctions.EXPM1);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix log()
     {
         assign(FloatMathFunctions.LOG);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix log10()
     {
         assign(FloatMathFunctions.LOG10);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix log1p()
     {
         assign(FloatMathFunctions.LOG1P);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix pow(final double x)
     {
         assign(FloatMathFunctions.POW((float) x));
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix signum()
     {
         assign(FloatMathFunctions.SIGNUM);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix sin()
     {
         assign(FloatMathFunctions.SIN);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix sinh()
     {
         assign(FloatMathFunctions.SINH);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix sqrt()
     {
         assign(FloatMathFunctions.SQRT);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix tan()
     {
         assign(FloatMathFunctions.TAN);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix tanh()
     {
         assign(FloatMathFunctions.TANH);
         return this;
     }
 
     /** {@inheritDoc} */
     @Override
     public final FloatDimensionlessMatrix inv()
     {
         assign(FloatMathFunctions.INV);
         return this;
     }
 
 }