org.ejml.data.FMatrix3 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ejml-core Show documentation
A fast and easy to use dense and sparse matrix linear algebra library written in Java.
There is a newer version: 0.43.1
/*
 * Copyright (c) 2020, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.ejml.data;

import org.ejml.ops.MatrixIO;

import javax.annotation.Generated;

/**
 * Fixed sized vector with 3 elements.  Can represent a 3 x 1 or 1 x 3 matrix, context dependent.
 *
 * DO NOT MODIFY. Automatically generated code created by GenerateMatrixFixedN
 *
 * @author Peter Abeles
 */
@Generated("org.ejml.data.GenerateMatrixFixedN")
public class FMatrix3 implements FMatrixFixed {
    public float a1,a2,a3;

    public FMatrix3() {}

    public FMatrix3( float a1, float a2, float a3 ) {
        this.a1 = a1;
        this.a2 = a2;
        this.a3 = a3;
    }

    public FMatrix3( FMatrix3 o ) {
        this.a1 = o.a1;
        this.a2 = o.a2;
        this.a3 = o.a3;
    }

    @Override public void zero() {
        a1 = 0.0f;
        a2 = 0.0f;
        a3 = 0.0f;
    }

    public void setTo( float a1, float a2, float a3 ) {
        this.a1 = a1;
        this.a2 = a2;
        this.a3 = a3;
    }

    public void setTo( int offset , float[] array ) {
        this.a1 = array[offset+0];
        this.a2 = array[offset+1];
        this.a3 = array[offset+2];
    }

    @Override public float get( int row, int col ) {return unsafe_get(row,col);}

    @Override public float unsafe_get( int row, int col ) {
        if (row != 0 && col != 0)
            throw new IllegalArgumentException("Row or column must be zero since this is a vector");

        int w = Math.max(row,col);

        if (w == 0) {
            return a1;
        } else if (w == 1) {
            return a2;
        } else if (w == 2) {
            return a3;
        } else {
            throw new IllegalArgumentException("Out of range.  "+w);
        }
    }

    @Override public void set( int row, int col, float val ) {
        unsafe_set(row,col,val);
    }

    @Override public void unsafe_set( int row, int col, float val ) {
        if (row != 0 && col != 0)
            throw new IllegalArgumentException("Row or column must be zero since this is a vector");

        int w = Math.max(row,col);

        if (w == 0) {
            a1 = val;
        } else if (w == 1) {
            a2 = val;
        } else if (w == 2) {
            a3 = val;
        } else {
            throw new IllegalArgumentException("Out of range.  "+w);
        }
    }

    @Override public void setTo( Matrix original ) {
        FMatrix m = (FMatrix)original;

        if (m.getNumCols() == 1 && m.getNumRows() == 3) {
            a1 = m.get(0,0);
            a2 = m.get(1,0);
            a3 = m.get(2,0);
        } else if (m.getNumRows() == 1 && m.getNumCols() == 3) {
            a1 = m.get(0,0);
            a2 = m.get(0,1);
            a3 = m.get(0,2);
        } else {
            throw new IllegalArgumentException("Incompatible shape");
        }
    }

    @Override public int getNumRows() {return 3;}

    @Override public int getNumCols() {return 1;}

    @Override public int getNumElements() {return 3;}

    @Override public  T copy() {
        return (T)new FMatrix3(this);
    }

    @Override public void print() {
        MatrixIO.printFancy(System.out, this, MatrixIO.DEFAULT_LENGTH);
    }

    @Override public void print( String format ) {
        MatrixIO.print(System.out, this, format);
    }

    @Override public  T createLike() {return (T)new FMatrix3();}

    @Override public MatrixType getType() {return MatrixType.UNSPECIFIED;}
}