com.io7m.jtensors.MatrixReadableD Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013  http://io7m.com
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jtensors;

import java.nio.DoubleBuffer;

import javax.annotation.Nonnull;

/**
 * 'Read' interface to matrices with double precision elements.
 */

public interface MatrixReadableD
{
  /**
   * Return a view of the buffer that backs this matrix.
   */

  public @Nonnull DoubleBuffer getDoubleBuffer();

  /**
   * Retrieve the value from the matrix at row row , column
   * column.
   */

  public double getRowColumnD(
    int row,
    int column);
}