blob: ffe1d2ca1e8970b896a2321356713bd78832b29b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>Matrix1 (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.referencing.operation.matrix.Matrix1 class">
<meta name="keywords" content="SIZE">
<meta name="keywords" content="m00">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="getNumRow()">
<meta name="keywords" content="getNumCol()">
<meta name="keywords" content="getElement()">
<meta name="keywords" content="setElement()">
<meta name="keywords" content="getElements()">
<meta name="keywords" content="setElements()">
<meta name="keywords" content="isAffine()">
<meta name="keywords" content="isIdentity()">
<meta name="keywords" content="transpose()">
<meta name="keywords" content="normalizeColumns()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="hashCode()">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Matrix1 (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Matrix1.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.operation.matrix</a></div>
<h2 title="Class Matrix1" class="title">Class Matrix1</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">MatrixSIS</a></li>
<li>
<ul class="inheritance">
<li>Matrix1</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="../../../util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">Matrix1</span>
extends <a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">MatrixSIS</a></pre>
<div class="block">A matrix of fixed <a href="#SIZE">1</a>×<a href="#SIZE">1</a> size,
typically resulting from <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform1D.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>Math­Transform1D</code></a> derivative computation.
The matrix member is:
<blockquote><pre> ┌ ┐
<a href="#m00">m00</a>
└ ┘</pre></blockquote></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Matrix2.html" title="class in org.apache.sis.referencing.operation.matrix"><code>Matrix2</code></a>,
<a href="Matrix3.html" title="class in org.apache.sis.referencing.operation.matrix"><code>Matrix3</code></a>,
<a href="Matrix4.html" title="class in org.apache.sis.referencing.operation.matrix"><code>Matrix4</code></a>,
<a href="../../../../../../serialized-form.html#org.apache.sis.referencing.operation.matrix.Matrix1">Serialized Form</a></dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#m00">m00</a></span></code></th>
<td class="colLast">
<div class="block">The only element in this matrix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SIZE">SIZE</a></span></code></th>
<td class="colLast">
<div class="block">The matrix size, which is 1.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Matrix1</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new identity matrix.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(double)">Matrix1</a></span>&#8203;(double&nbsp;m00)</code></th>
<td class="colLast">
<div class="block">Creates a new matrix initialized to the specified value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(double%5B%5D)">Matrix1</a></span>&#8203;(double[]&nbsp;elements)</code></th>
<td class="colLast">
<div class="block">Creates a new matrix initialized to the specified values.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="Matrix1.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix1</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.referencing.operation.Matrix)">castOrCopy</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a>&nbsp;matrix)</code></th>
<td class="colLast">
<div class="block">Casts or copies the given matrix to a <code>Matrix1</code> implementation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if the specified object is of type <code>Matrix1</code> and
all of the data members are equal to the corresponding data members in this matrix.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getElement(int,int)">getElement</a></span>&#8203;(int&nbsp;row,
int&nbsp;column)</code></th>
<td class="colLast">
<div class="block">Retrieves the value at the specified row and column of this matrix.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getElements()">getElements</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all matrix elements in a flat, row-major (column indices vary fastest) array.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumCol()">getNumCol</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of columns in this matrix, which is always <a href="#SIZE">1</a> in this implementation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumRow()">getNumRow</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of rows in this matrix, which is always <a href="#SIZE">1</a> in this implementation.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a hash code value based on the data values in this object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAffine()">isAffine</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this matrix represents an affine transform.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIdentity()">isIdentity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this matrix is an identity matrix.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalizeColumns()">normalizeColumns</a></span>()</code></th>
<td class="colLast">
<div class="block">Normalizes all columns in-place.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setElement(int,int,double)">setElement</a></span>&#8203;(int&nbsp;row,
int&nbsp;column,
double&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Modifies the value at the specified row and column of this matrix.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setElements(double%5B%5D)">setElements</a></span>&#8203;(double[]&nbsp;elements)</code></th>
<td class="colLast">
<div class="block">Sets all matrix elements from a flat, row-major (column indices vary fastest) array.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transpose()">transpose</a></span>()</code></th>
<td class="colLast">
<div class="block">For a 1×1 matrix, this method does nothing.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.MatrixSIS">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">MatrixSIS</a></h3>
<code><a href="MatrixSIS.html#clone()">clone</a>, <a href="MatrixSIS.html#convertAfter(int,java.lang.Number,java.lang.Number)">convert­After</a>, <a href="MatrixSIS.html#convertBefore(int,java.lang.Number,java.lang.Number)">convert­Before</a>, <a href="MatrixSIS.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="MatrixSIS.html#equals(org.opengis.referencing.operation.Matrix,double)">equals</a>, <a href="MatrixSIS.html#getNumber(int,int)">get­Number</a>, <a href="MatrixSIS.html#inverse()">inverse</a>, <a href="MatrixSIS.html#multiply(double%5B%5D)">multiply</a>, <a href="MatrixSIS.html#multiply(org.opengis.referencing.operation.Matrix)">multiply</a>, <a href="MatrixSIS.html#removeColumns(int,int)">remove­Columns</a>, <a href="MatrixSIS.html#removeRows(int,int)">remove­Rows</a>, <a href="MatrixSIS.html#setMatrix(org.opengis.referencing.operation.Matrix)">set­Matrix</a>, <a href="MatrixSIS.html#setNumber(int,int,java.lang.Number)">set­Number</a>, <a href="MatrixSIS.html#solve(org.opengis.referencing.operation.Matrix)">solve</a>, <a href="MatrixSIS.html#toString()">to­String</a>, <a href="MatrixSIS.html#translate(double%5B%5D)">translate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">get­Class</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notify­All</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SIZE</h4>
<pre>public static final&nbsp;int SIZE</pre>
<div class="block">The matrix size, which is 1.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.sis.referencing.operation.matrix.Matrix1.SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="m00">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m00</h4>
<pre>public&nbsp;double m00</pre>
<div class="block">The only element in this matrix.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Matrix1</h4>
<pre>public&nbsp;Matrix1()</pre>
<div class="block">Creates a new identity matrix.</div>
</li>
</ul>
<a id="&lt;init&gt;(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Matrix1</h4>
<pre>public&nbsp;Matrix1&#8203;(double&nbsp;m00)</pre>
<div class="block">Creates a new matrix initialized to the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m00</code> - The element in this matrix.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(double[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Matrix1</h4>
<pre>public&nbsp;Matrix1&#8203;(double[]&nbsp;elements)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre>
<div class="block">Creates a new matrix initialized to the specified values.
The length of the given array must be 1.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elements</code> - elements of the matrix.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­Argument­Exception</a></code> - if the given array does not have the expected length.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setElements(double%5B%5D)"><code>set­Elements(double[])</code></a>,
<a href="Matrices.html#create(int,int,double%5B%5D)"><code>Matrices​.create(int, int, double[])</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="castOrCopy(org.opengis.referencing.operation.Matrix)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>castOrCopy</h4>
<pre class="methodSignature">public static&nbsp;<a href="Matrix1.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix1</a>&nbsp;castOrCopy&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a>&nbsp;matrix)
throws <a href="MismatchedMatrixSizeException.html" title="class in org.apache.sis.referencing.operation.matrix">MismatchedMatrixSizeException</a></pre>
<div class="block">Casts or copies the given matrix to a <code>Matrix1</code> implementation. If the given <code>matrix</code>
is already an instance of <code>Matrix1</code>, then it is returned unchanged. Otherwise this method
verifies the matrix size, then copies the element in a new <code>Matrix1</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>matrix</code> - the matrix to cast or copy, or <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the matrix argument if it can be safely casted (including <code>null</code> argument),
or a copy of the given matrix otherwise.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="MismatchedMatrixSizeException.html" title="class in org.apache.sis.referencing.operation.matrix">Mismatched­Matrix­Size­Exception</a></code> - if the size of the given matrix is not <a href="#SIZE">1</a>×<a href="#SIZE">1</a>.</dd>
</dl>
</li>
</ul>
<a id="getNumRow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumRow</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;getNumRow()</pre>
<div class="block">Returns the number of rows in this matrix, which is always <a href="#SIZE">1</a> in this implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>always <a href="#SIZE">1</a>.</dd>
</dl>
</li>
</ul>
<a id="getNumCol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumCol</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;getNumCol()</pre>
<div class="block">Returns the number of columns in this matrix, which is always <a href="#SIZE">1</a> in this implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>always <a href="#SIZE">1</a>.</dd>
</dl>
</li>
</ul>
<a id="getElement(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElement</h4>
<pre class="methodSignature">public final&nbsp;double&nbsp;getElement&#8203;(int&nbsp;row,
int&nbsp;column)</pre>
<div class="block">Retrieves the value at the specified row and column of this matrix.
This method can be invoked when the matrix size or type is unknown.
If the matrix is known to be an instance of <code>Matrix1</code>,
then the <a href="#m00"><code>m00</code></a> field can be read directly for efficiency.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true#getElement(int,int)" title="class or interface in org.opengis.referencing.operation" class="externalLink">get­Element</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MatrixSIS.html#getElement(int,int)">get­Element</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - the row index, which can only be 0.</dd>
<dd><code>column</code> - the column index, which can only be 0.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current value.</dd>
</dl>
</li>
</ul>
<a id="setElement(int,int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setElement</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setElement&#8203;(int&nbsp;row,
int&nbsp;column,
double&nbsp;value)</pre>
<div class="block">Modifies the value at the specified row and column of this matrix.
This method can be invoked when the matrix size or type is unknown.
If the matrix is known to be an instance of <code>Matrix1</code>,
then the <a href="#m00"><code>m00</code></a> field can be set directly for efficiency.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - the row index, which can only be 0.</dd>
<dd><code>column</code> - the column index, which can only be 0.</dd>
<dd><code>value</code> - the new value to set.</dd>
</dl>
</li>
</ul>
<a id="getElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElements</h4>
<pre class="methodSignature">public final&nbsp;double[]&nbsp;getElements()</pre>
<div class="block">Returns all matrix elements in a flat, row-major (column indices vary fastest) array.
The array length is 1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="MatrixSIS.html#getElements()">get­Elements</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of all current matrix elements in a row-major array.</dd>
</dl>
</li>
</ul>
<a id="setElements(double[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setElements</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setElements&#8203;(double[]&nbsp;elements)</pre>
<div class="block">Sets all matrix elements from a flat, row-major (column indices vary fastest) array.
The array length shall be 1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MatrixSIS.html#setElements(double%5B%5D)">set­Elements</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elements</code> - The new matrix elements in a row-major array.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Matrices.html#create(int,int,double%5B%5D)"><code>Matrices​.create(int, int, double[])</code></a></dd>
</dl>
</li>
</ul>
<a id="isAffine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAffine</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isAffine()</pre>
<div class="block">Returns <code>true</code> if this matrix represents an affine transform.
A transform is affine if the matrix is square and its last row contains
only zeros, except in the last column which contains 1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="MatrixSIS.html#isAffine()">is­Affine</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this matrix represents an affine transform.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Matrices.html#isAffine(org.opengis.referencing.operation.Matrix)"><code>Matrices​.is­Affine(Matrix)</code></a>,
<a href="../transform/LinearTransform.html#isAffine()"><code>Linear­Transform​.is­Affine()</code></a></dd>
</dl>
</li>
</ul>
<a id="isIdentity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIdentity</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isIdentity()</pre>
<div class="block">Returns <code>true</code> if this matrix is an identity matrix.
This method is equivalent to the following code, except that it is potentially more efficient:
<blockquote><pre><font color="green">return</font> Matrices.<b>isIdentity</b>(<font color="green">this</font>, 0.0);</pre></blockquote></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true#isIdentity()" title="class or interface in org.opengis.referencing.operation" class="externalLink">is­Identity</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MatrixSIS.html#isIdentity()">is­Identity</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this matrix is an identity matrix.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Matrices.html#isIdentity(org.opengis.referencing.operation.Matrix,double)"><code>Matrices​.is­Identity(Matrix, double)</code></a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/geom/AffineTransform.html?is-external=true#isIdentity()" title="class or interface in java.awt.geom" class="externalLink"><code>Affine­Transform​.is­Identity()</code></a></dd>
</dl>
</li>
</ul>
<a id="transpose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transpose</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;transpose()</pre>
<div class="block">For a 1×1 matrix, this method does nothing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MatrixSIS.html#transpose()">transpose</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
</dl>
</li>
</ul>
<a id="normalizeColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalizeColumns</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;normalizeColumns()</pre>
<div class="block">Normalizes all columns in-place.
For a 1×1 matrix, this method just sets unconditionally the <a href="#m00"><code>m00</code></a> value to 1.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="MatrixSIS.html#normalizeColumns()">normalize­Columns</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<div class="block">Returns <code>true</code> if the specified object is of type <code>Matrix1</code> and
all of the data members are equal to the corresponding data members in this matrix.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/LenientComparable.html#equals(java.lang.Object)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="MatrixSIS.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the object to compare with this matrix for equality.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the given object is equal to this matrix.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/ComparisonMode.html#STRICT"><code>Comparison­Mode​.STRICT</code></a></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code value based on the data values in this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="MatrixSIS.html#hashCode()">hash­Code</a></code>&nbsp;in class&nbsp;<code><a href="MatrixSIS.html" title="class in org.apache.sis.referencing.operation.matrix">Matrix­SIS</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code value for this matrix.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Matrix1.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>