Class DoubleFactory3D

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class DoubleFactory3D
    extends PersistentObject
    Factory for convenient construction of 3-d matrices holding double cells. Use idioms like DoubleFactory3D.dense.make(4,4,4) to construct dense matrices, DoubleFactory3D.sparse.make(4,4,4) to construct sparse matrices. If the factory is used frequently it might be useful to streamline the notation. For example by aliasing:
    DoubleFactory3D F = DoubleFactory3D.dense;
    F.make(4,4,4);
    F.descending(10,20,5);
    F.random(4,4,5);
    ...
    
    Version:
    1.0, 09/24/99
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected DoubleFactory3D()
      Makes this class non instantiable, but still let's others inherit from it.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DoubleMatrix3D ascending​(int slices, int rows, int columns)
      Constructs a matrix with cells having ascending values.
      DoubleMatrix3D descending​(int slices, int rows, int columns)
      Constructs a matrix with cells having descending values.
      DoubleMatrix3D make​(double[][][] values)
      Constructs a matrix with the given cell values.
      DoubleMatrix3D make​(int slices, int rows, int columns)
      Constructs a matrix with the given shape, each cell initialized with zero.
      DoubleMatrix3D make​(int slices, int rows, int columns, double initialValue)
      Constructs a matrix with the given shape, each cell initialized with the given value.
      DoubleMatrix3D random​(int slices, int rows, int columns)
      Constructs a matrix with uniformly distributed values in (0,1) (exclusive).
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • dense

        public static final DoubleFactory3D dense
        A factory producing dense matrices.
      • sparse

        public static final DoubleFactory3D sparse
        A factory producing sparse matrices.
    • Constructor Detail

      • DoubleFactory3D

        protected DoubleFactory3D()
        Makes this class non instantiable, but still let's others inherit from it.
    • Method Detail

      • ascending

        public DoubleMatrix3D ascending​(int slices,
                                        int rows,
                                        int columns)
        Constructs a matrix with cells having ascending values. For debugging purposes.
      • descending

        public DoubleMatrix3D descending​(int slices,
                                         int rows,
                                         int columns)
        Constructs a matrix with cells having descending values. For debugging purposes.
      • make

        public DoubleMatrix3D make​(double[][][] values)
        Constructs a matrix with the given cell values. values is required to have the form values[slice][row][column] and have exactly the same number of slices, rows and columns as the receiver.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).
        Throws:
        java.lang.IllegalArgumentException - if values.length != slices() || for any 0 <= slice < slices(): values[slice].length != rows().
        java.lang.IllegalArgumentException - if for any 0 <= column < columns(): values[slice][row].length != columns().
      • make

        public DoubleMatrix3D make​(int slices,
                                   int rows,
                                   int columns)
        Constructs a matrix with the given shape, each cell initialized with zero.
      • make

        public DoubleMatrix3D make​(int slices,
                                   int rows,
                                   int columns,
                                   double initialValue)
        Constructs a matrix with the given shape, each cell initialized with the given value.
      • random

        public DoubleMatrix3D random​(int slices,
                                     int rows,
                                     int columns)
        Constructs a matrix with uniformly distributed values in (0,1) (exclusive).