org.n52.matlab.control.link.MatlabNumericMatrix Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of matlab-control Show documentation
MATLAB Control
The newest version!
package org.n52.matlab.control.link;

/*
 * Copyright (c) 2013, Joshua Kaplan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *  - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 *    disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other materials provided with the distribution.
 *  - Neither the name of matlabcontrol nor the names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 *
 * @since 4.2.0
 * @author Joshua Kaplan
 */
abstract class MatlabNumericMatrix extends MatlabMatrix
{   
    /**
     * Returns {@code true} if the array has no imaginary values, {@code false} otherwise. Equivalent to the MATLAB
     * {@code isreal} function.
     * 
     * @return 
     */
    public boolean isReal()
    {
        return getBaseArray().isReal();
    }
    
    /**
     * Returns an array that holds the real values from the MATLAB array. Each call returns a new copy which may be used
     * in any manner; modifications to it will have no effect on this instance.
     * 
     * @return real array
     */
    public T toRealArray()
    {
        return getBaseArray().toRealArray();
    }
    
    /**
     * Returns an array that holds the imaginary values from the MATLAB array. Each call returns a new copy which may be
     * used in any manner; modifications to it will have no effect on this instance. If this array is real then the
     * returned array will be have {@code 0} as all of its base elements.
     * 
     * @return imaginary array
     */
    public T toImaginaryArray()
    {
        return getBaseArray().toImaginaryArray();
    }
    
    
    /**
     * Gets the element at {@code index} treating this array as a MATLAB column vector. This is equivalent to indexing
     * into a MATLAB array with just one subscript.
     * 
     * @param index
     * @return element at {@code index}
     * @throws ArrayIndexOutOfBoundsException if {@code index} is out of bounds
     */
    public abstract MatlabNumber getElementAtLinearIndex(int index);
    
    public abstract MatlabNumber getElementAtIndices(int row, int column);
    
    public abstract MatlabNumber getElementAtIndices(int row, int column, int page);
    
    
    
    /**
     * Gets the element at the specified {@code row}, {@code column}, and {@code pages}.
     * 
     * @param row
     * @param column
     * @param pages
     * @return element at {@code row}, {@code column}, and {@code pages}
     * @throws IllegalArgumentException if number of indices does not equal this array's number of dimensions
     * @throws ArrayIndexOutOfBoundsException if the indices are out of bound
     */
    public abstract MatlabNumber getElementAtIndices(int row, int column, int... pages);
}