cern.colt.matrix.tfcomplex.FComplexFactory3D Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parallelcolt Show documentation

Parallel Colt is a multithreaded version of Colt - a library for high performance scientific computing in Java. It contains efficient algorithms for data analysis, linear algebra, multi-dimensional arrays, Fourier transforms, statistics and histogramming.

The newest version!

/*
Copyright (C) 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose 
is hereby granted without fee, provided that the above copyright notice appear in all copies and 
that both that copyright notice and this permission notice appear in supporting documentation. 
CERN makes no representations about the suitability of this software for any purpose. 
It is provided "as is" without expressed or implied warranty.
 */
package cern.colt.matrix.tfcomplex;

import cern.colt.matrix.tfcomplex.impl.DenseFComplexMatrix3D;
import cern.colt.matrix.tfcomplex.impl.SparseFComplexMatrix3D;

/**
 * Factory for convenient construction of 3-d matrices holding complex
 * cells. Use idioms like ComplexFactory3D.dense.make(4,4,4) to
 * construct dense matrices, ComplexFactory3D.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:
 * 
 * 
 * 
 * 
 *  *  ComplexFactory3D F = ComplexFactory3D.dense;
 *  F.make(4,4,4);
 *  F.random(4,4,5);
 *  ...
 * 
 * 
 * 
 * 
 * @author Piotr Wendykier ([email protected])
 * @version 1.0, 12/10/2007
 */
public class FComplexFactory3D extends cern.colt.PersistentObject {
    private static final long serialVersionUID = 1L;

    /**
     * A factory producing dense matrices.
     */
    public static final FComplexFactory3D dense = new FComplexFactory3D();

    /**
     * A factory producing sparse matrices.
     */
    public static final FComplexFactory3D sparse = new FComplexFactory3D();

    /**
     * Makes this class non instantiable, but still let's others inherit from
     * it.
     */
    protected FComplexFactory3D() {
    }

    /**
     * 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.
     * 
     * @param values
     *            the values to be filled into the cells.
     * @return this (for convenience only).
     * @throws IllegalArgumentException
     *             if
     *             values.length != slices() || for any 0 <= slice < slices(): values[slice].length != rows()
     *             .
     * @throws IllegalArgumentException
     *             if
     *             for any 0 <= column < columns(): values[slice][row].length != columns()
     *             .
     */
    public FComplexMatrix3D make(float[][][] values) {
        if (this == sparse) {
            return new SparseFComplexMatrix3D(values);
        } else {
            return new DenseFComplexMatrix3D(values);
        }
    }

    /**
     * Constructs a matrix with the given shape, each cell initialized with
     * zero.
     */
    public FComplexMatrix3D make(int slices, int rows, int columns) {
        if (this == sparse) {
            return new SparseFComplexMatrix3D(slices, rows, columns);
        } else {
            return new DenseFComplexMatrix3D(slices, rows, columns);
        }
    }

    /**
     * Constructs a matrix with the given shape, each cell initialized with the
     * given value.
     */
    public FComplexMatrix3D make(int slices, int rows, int columns, float[] initialValue) {
        return make(slices, rows, columns).assign(initialValue);
    }

    /**
     * Constructs a matrix with uniformly distributed values in (0,1)
     * (exclusive).
     */
    public FComplexMatrix3D random(int slices, int rows, int columns) {
        return make(slices, rows, columns).assign(cern.jet.math.tfcomplex.FComplexFunctions.random());
    }
}