blob: 3b831ff64ddc904beb30dcec79840b40a717b782 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:10:57 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FileBasedSparseBinaryMatrix (Mahout Math 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileBasedSparseBinaryMatrix (Mahout Math 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FileBasedSparseBinaryMatrix.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">
<li><a href="../../../../org/apache/mahout/math/FileBasedMatrix.html" title="class in org.apache.mahout.math"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.BinaryReadOnlyElement.html" title="class in org.apache.mahout.math"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mahout/math/FileBasedSparseBinaryMatrix.html" target="_top">Frames</a></li>
<li><a href="FileBasedSparseBinaryMatrix.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.mahout.math.AbstractMatrix">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mahout.math</div>
<h2 title="Class FileBasedSparseBinaryMatrix" class="title">Class FileBasedSparseBinaryMatrix</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">org.apache.mahout.math.AbstractMatrix</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.math.FileBasedSparseBinaryMatrix</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/mahout/math/MatrixSlice.html" title="class in org.apache.mahout.math">MatrixSlice</a>&gt;, <a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>, <a href="../../../../org/apache/mahout/math/VectorIterable.html" title="interface in org.apache.mahout.math">VectorIterable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">FileBasedSparseBinaryMatrix</span>
extends <a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></pre>
<div class="block">Provides a way to get data from a file and treat it as if it were a matrix, but avoids putting
all that data onto the Java heap. Instead, the file is mapped into non-heap memory as a
DoubleBuffer and we access that instead. The interesting aspect of this is that the values in
the matrix are binary and sparse so we don't need to store the actual data, just the location of
non-zero values.
<p>
Currently file data is formatted as follows:
<p>
<ul> <li>A magic number to indicate the file format.</li> <li>The size of the matrix (max rows
and columns possible)</li> <li>Number of non-zeros in each row.</li> <li>A list of non-zero
columns for each row. The list starts with a count and then has column numbers</li> </ul>
<p>
It would be preferable to use something like protobufs to define the format so that we can use
different row formats for different kinds of data. For instance, Golay coding of column numbers
or compressed bit vectors might be good representations for some purposes.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.BinaryReadOnlyElement.html" title="class in org.apache.mahout.math">FileBasedSparseBinaryMatrix.BinaryReadOnlyElement</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.mahout.math.AbstractMatrix">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.mahout.math.<a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></h3>
<code><a href="../../../../org/apache/mahout/math/AbstractMatrix.TransposeViewVector.html" title="class in org.apache.mahout.math">AbstractMatrix.TransposeViewVector</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.mahout.math.AbstractMatrix">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.mahout.math.<a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></h3>
<code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html#COL">COL</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#columnLabelBindings">columnLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#columns">columns</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#ROW">ROW</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#rowLabelBindings">rowLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#rows">rows</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#FileBasedSparseBinaryMatrix-int-int-">FileBasedSparseBinaryMatrix</a></span>(int&nbsp;rows,
int&nbsp;columns)</code>
<div class="block">Constructs an empty matrix of the given size.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#assignColumn-int-org.apache.mahout.math.Vector-">assignColumn</a></span>(int&nbsp;column,
<a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a>&nbsp;other)</code>
<div class="block">Assign the other vector values to the column of the receiver</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#assignRow-int-org.apache.mahout.math.Vector-">assignRow</a></span>(int&nbsp;row,
<a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a>&nbsp;other)</code>
<div class="block">Assign the other vector values to the row of the receiver</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#getQuick-int-int-">getQuick</a></span>(int&nbsp;rowIndex,
int&nbsp;columnIndex)</code>
<div class="block">Return the value at the given indexes, without checking bounds</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#like--">like</a></span>()</code>
<div class="block">Return an empty matrix of the same underlying class as the receiver</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#like-int-int-">like</a></span>(int&nbsp;rows,
int&nbsp;columns)</code>
<div class="block">Returns an empty matrix of the same underlying class as the receiver and of the specified
size.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#setData-java.io.File-">setData</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;f)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#setQuick-int-int-double-">setQuick</a></span>(int&nbsp;row,
int&nbsp;column,
double&nbsp;value)</code>
<div class="block">Set the value at the given index, without checking bounds</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#viewPart-int:A-int:A-">viewPart</a></span>(int[]&nbsp;offset,
int[]&nbsp;size)</code>
<div class="block">Return a view into part of a matrix.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#viewRow-int-">viewRow</a></span>(int&nbsp;rowIndex)</code>
<div class="block">Returns a view of a row.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.html#writeMatrix-java.io.File-org.apache.mahout.math.Matrix-">writeMatrix</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;f,
<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;m)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.math.AbstractMatrix">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mahout.math.<a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></h3>
<code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html#aggregate-org.apache.mahout.math.function.DoubleDoubleFunction-org.apache.mahout.math.function.DoubleFunction-">aggregate</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#aggregateColumns-org.apache.mahout.math.function.VectorFunction-">aggregateColumns</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#aggregateRows-org.apache.mahout.math.function.VectorFunction-">aggregateRows</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#asFormatString--">asFormatString</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#assign-double-">assign</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#assign-double:A:A-">assign</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#assign-org.apache.mahout.math.function.DoubleFunction-">assign</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#assign-org.apache.mahout.math.Matrix-">assign</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#assign-org.apache.mahout.math.Matrix-org.apache.mahout.math.function.DoubleDoubleFunction-">assign</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#clone--">clone</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#columnSize--">columnSize</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#determinant--">determinant</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#divide-double-">divide</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#get-int-int-">get</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#get-java.lang.String-java.lang.String-">get</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#getColumnLabelBindings--">getColumnLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#getFlavor--">getFlavor</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#getNumNondefaultElements--">getNumNondefaultElements</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#getRowLabelBindings--">getRowLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#iterateAll--">iterateAll</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#iterateNonEmpty--">iterateNonEmpty</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#iterator--">iterator</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#minus-org.apache.mahout.math.Matrix-">minus</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#numCols--">numCols</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#numRows--">numRows</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#numSlices--">numSlices</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#plus-double-">plus</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#plus-org.apache.mahout.math.Matrix-">plus</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#rowSize--">rowSize</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-int-double:A-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-int-int-double-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-java.lang.String-double:A-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-java.lang.String-int-double:A-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-java.lang.String-java.lang.String-double-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#set-java.lang.String-java.lang.String-int-int-double-">set</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#setColumnLabelBindings-java.util.Map-">setColumnLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#setRowLabelBindings-java.util.Map-">setRowLabelBindings</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#times-double-">times</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#times-org.apache.mahout.math.Matrix-">times</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#times-org.apache.mahout.math.Vector-">times</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#timesSquared-org.apache.mahout.math.Vector-">timesSquared</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#toString--">toString</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#transpose--">transpose</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#viewColumn-int-">viewColumn</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#viewDiagonal--">viewDiagonal</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#viewPart-int-int-int-int-">viewPart</a>, <a href="../../../../org/apache/mahout/math/AbstractMatrix.html#zSum--">zSum</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FileBasedSparseBinaryMatrix-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FileBasedSparseBinaryMatrix</h4>
<pre>public&nbsp;FileBasedSparseBinaryMatrix(int&nbsp;rows,
int&nbsp;columns)</pre>
<div class="block">Constructs an empty matrix of the given size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rows</code> - The number of rows in the result.</dd>
<dd><code>columns</code> - The number of columns in the result.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setData-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setData</h4>
<pre>public&nbsp;void&nbsp;setData(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;f)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeMatrix-java.io.File-org.apache.mahout.math.Matrix-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeMatrix</h4>
<pre>public static&nbsp;void&nbsp;writeMatrix(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;f,
<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;m)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="assignColumn-int-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignColumn</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;assignColumn(int&nbsp;column,
<a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a>&nbsp;other)</pre>
<div class="block">Assign the other vector values to the column of the receiver</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - the int row to assign</dd>
<dd><code>other</code> - a Vector</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified receiver</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/CardinalityException.html" title="class in org.apache.mahout.math">CardinalityException</a></code> - if the cardinalities differ</dd>
</dl>
</li>
</ul>
<a name="assignRow-int-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignRow</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;assignRow(int&nbsp;row,
<a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a>&nbsp;other)</pre>
<div class="block">Assign the other vector values to the row of the receiver</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - the int row to assign</dd>
<dd><code>other</code> - a Vector</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified receiver</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/CardinalityException.html" title="class in org.apache.mahout.math">CardinalityException</a></code> - if the cardinalities differ</dd>
</dl>
</li>
</ul>
<a name="getQuick-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuick</h4>
<pre>public&nbsp;double&nbsp;getQuick(int&nbsp;rowIndex,
int&nbsp;columnIndex)</pre>
<div class="block">Return the value at the given indexes, without checking bounds</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowIndex</code> - an int row index</dd>
<dd><code>columnIndex</code> - an int column index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the double at the index</dd>
</dl>
</li>
</ul>
<a name="like--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>like</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;like()</pre>
<div class="block">Return an empty matrix of the same underlying class as the receiver</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Matrix</dd>
</dl>
</li>
</ul>
<a name="like-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>like</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;like(int&nbsp;rows,
int&nbsp;columns)</pre>
<div class="block">Returns an empty matrix of the same underlying class as the receiver and of the specified
size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rows</code> - the int number of rows</dd>
<dd><code>columns</code> - the int number of columns</dd>
</dl>
</li>
</ul>
<a name="setQuick-int-int-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuick</h4>
<pre>public&nbsp;void&nbsp;setQuick(int&nbsp;row,
int&nbsp;column,
double&nbsp;value)</pre>
<div class="block">Set the value at the given index, without checking bounds</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - an int row index into the receiver</dd>
<dd><code>column</code> - an int column index into the receiver</dd>
<dd><code>value</code> - a double value to set</dd>
</dl>
</li>
</ul>
<a name="viewPart-int:A-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>viewPart</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a>&nbsp;viewPart(int[]&nbsp;offset,
int[]&nbsp;size)</pre>
<div class="block">Return a view into part of a matrix. Changes to the view will change the original matrix.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/Matrix.html#viewPart-int:A-int:A-">viewPart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html#viewPart-int:A-int:A-">viewPart</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - an int[2] offset into the receiver</dd>
<dd><code>size</code> - the int[2] size of the desired result</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a matrix that shares storage with part of the original matrix.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/CardinalityException.html" title="class in org.apache.mahout.math">CardinalityException</a></code> - if the length is greater than the cardinality of the receiver</dd>
<dd><code><a href="../../../../org/apache/mahout/math/IndexException.html" title="class in org.apache.mahout.math">IndexException</a></code> - if the offset is negative or the offset+length is outside of the receiver</dd>
</dl>
</li>
</ul>
<a name="viewRow-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>viewRow</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a>&nbsp;viewRow(int&nbsp;rowIndex)</pre>
<div class="block">Returns a view of a row. Changes to the view will affect the original.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/Matrix.html#viewRow-int-">viewRow</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html#viewRow-int-">viewRow</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/mahout/math/AbstractMatrix.html" title="class in org.apache.mahout.math">AbstractMatrix</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowIndex</code> - Which row to return.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A vector that references the desired row.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FileBasedSparseBinaryMatrix.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">
<li><a href="../../../../org/apache/mahout/math/FileBasedMatrix.html" title="class in org.apache.mahout.math"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mahout/math/FileBasedSparseBinaryMatrix.BinaryReadOnlyElement.html" title="class in org.apache.mahout.math"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mahout/math/FileBasedSparseBinaryMatrix.html" target="_top">Frames</a></li>
<li><a href="FileBasedSparseBinaryMatrix.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.mahout.math.AbstractMatrix">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>