001    /*
002     * Copyright (C) 2008-2010 by Holger Arndt
003     *
004     * This file is part of the Universal Java Matrix Package (UJMP).
005     * See the NOTICE file distributed with this work for additional
006     * information regarding copyright ownership and licensing.
007     *
008     * UJMP is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU Lesser General Public License as
010     * published by the Free Software Foundation; either version 2
011     * of the License, or (at your option) any later version.
012     *
013     * UJMP is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
016     * GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public
019     * License along with UJMP; if not, write to the
020     * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
021     * Boston, MA  02110-1301  USA
022     */
023    
024    package org.ujmp.core.doublematrix.calculation.entrywise.creators;
025    
026    import org.ujmp.core.Matrix;
027    import org.ujmp.core.calculation.Calculation.Ret;
028    import org.ujmp.core.exceptions.MatrixException;
029    
030    public interface CreatorDoubleCalculations {
031    
032            /**
033             * Returns a matrix with equal size, where all entries are set to zero.
034             * 
035             * @return Matrix with zeros.
036             */
037            public Matrix zeros(Ret ret) throws MatrixException;
038    
039            /**
040             * Returns a matrix with equal size, where all entries are set to 1.0.
041             * 
042             * @return Matrix with ones.
043             */
044            public Matrix ones(Ret ret) throws MatrixException;
045    
046            /**
047             * Returns a matrix with equal size, where all entries are set to uniform
048             * random values between 0.0 and 1.0.
049             * 
050             * @return Matrix with uniformly distributed values.
051             */
052            public Matrix rand(Ret ret) throws MatrixException;
053    
054            /**
055             * Returns a matrix with equal size, where all entries are set to random
056             * values which are normally distributed with 0.0 mean and 1.0 standard
057             * deviation.
058             * 
059             * @return Matrix with normally distributed values.
060             */
061            public Matrix randn(Ret ret) throws MatrixException;
062    
063            /**
064             * Returns a matrix with ones at the diagonal.
065             * 
066             * @return Eye matrix with ones at the diagonal
067             */
068            public Matrix eye(Ret ret) throws MatrixException;
069    
070    }