org.apache.mahout.math.FunctionalMatrixView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mahout-math Show documentation

High performance scientific and technical computing data structures and methods, mostly based on CERN's Colt Java API

There is a newer version: 0.13.0

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.mahout.math;

import org.apache.mahout.math.flavor.BackEnum;
import org.apache.mahout.math.flavor.MatrixFlavor;
import org.apache.mahout.math.flavor.TraversingStructureEnum;
import org.apache.mahout.math.function.IntIntFunction;

/**
 * Matrix View backed by an {@link IntIntFunction}
 */
class FunctionalMatrixView extends AbstractMatrix {

  /**
   * view generator function
   */
  private IntIntFunction gf;
  private boolean denseLike;
  private MatrixFlavor flavor;

  public FunctionalMatrixView(int rows, int columns, IntIntFunction gf) {
    this(rows, columns, gf, false);
  }

  /**
   * @param gf        generator function
   * @param denseLike whether like() should create Dense or Sparse matrix.
   */
  public FunctionalMatrixView(int rows, int columns, IntIntFunction gf, boolean denseLike) {
    super(rows, columns);
    this.gf = gf;
    this.denseLike = denseLike;
    flavor = new MatrixFlavor.FlavorImpl(BackEnum.JVMMEM, TraversingStructureEnum.BLOCKIFIED, denseLike);
  }

  @Override
  public Matrix assignColumn(int column, Vector other) {
    throw new UnsupportedOperationException("Assignment to a matrix not supported");
  }

  @Override
  public Matrix assignRow(int row, Vector other) {
    throw new UnsupportedOperationException("Assignment to a matrix view not supported");
  }

  @Override
  public double getQuick(int row, int column) {
    return gf.apply(row, column);
  }

  @Override
  public Matrix like() {
    return like(rows, columns);
  }

  @Override
  public Matrix like(int rows, int columns) {
    if (denseLike)
      return new DenseMatrix(rows, columns);
    else
      return new SparseMatrix(rows, columns);
  }

  @Override
  public void setQuick(int row, int column, double value) {
    throw new UnsupportedOperationException("Assignment to a matrix view not supported");
  }

  @Override
  public Vector viewRow(int row) {
    return new MatrixVectorView(this, row, 0, 0, 1, denseLike);
  }

  @Override
  public Vector viewColumn(int column) {
    return new MatrixVectorView(this, 0, column, 1, 0, denseLike);
  }

  @Override
  public MatrixFlavor getFlavor() {
    return flavor;
  }
}