blob: 367eac5acfb76d4be7792499bf657c7466849117 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LibMatrixDatagen (SystemDS 2.1.0-SNAPSHOT API)</title>
<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="LibMatrixDatagen (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":41,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/LibMatrixDatagen.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/sysds/runtime/matrix/data/LibMatrixCuMatMult.html" title="class in org.apache.sysds.runtime.matrix.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDNN.html" title="class in org.apache.sysds.runtime.matrix.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html" target="_top">Frames</a></li>
<li><a href="LibMatrixDatagen.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.sysds.runtime.matrix.data</div>
<h2 title="Class LibMatrixDatagen" class="title">Class LibMatrixDatagen</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.runtime.matrix.data.LibMatrixDatagen</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">LibMatrixDatagen</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/LongStream.html?is-external=true" title="class or interface in java.util.stream">LongStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#computeNNZperBlock-long-long-int-double-">computeNNZperBlock</a></span>(long&nbsp;nrow,
long&nbsp;ncol,
int&nbsp;blen,
double&nbsp;sparsity)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#createRandomMatrixGenerator-java.lang.String-int-int-int-double-double-double-java.lang.String-">createRandomMatrixGenerator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pdfStr,
int&nbsp;r,
int&nbsp;c,
int&nbsp;blen,
double&nbsp;sp,
double&nbsp;min,
double&nbsp;max,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;distParams)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#generateRandomMatrix-org.apache.sysds.runtime.matrix.data.MatrixBlock-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator-org.apache.commons.math3.random.Well1024a-long-">generateRandomMatrix</a></span>(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a>&nbsp;rgen,
org.apache.commons.math3.random.Well1024a&nbsp;bigrand,
long&nbsp;bSeed)</code>
<div class="block">Function to generate a matrix of random numbers.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#generateRandomMatrix-org.apache.sysds.runtime.matrix.data.MatrixBlock-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator-org.apache.commons.math3.random.Well1024a-long-int-">generateRandomMatrix</a></span>(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a>&nbsp;rgen,
org.apache.commons.math3.random.Well1024a&nbsp;bigrand,
long&nbsp;bSeed,
int&nbsp;k)</code>
<div class="block">Function to generate a matrix of random numbers.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#generateSample-org.apache.sysds.runtime.matrix.data.MatrixBlock-long-int-boolean-long-">generateSample</a></span>(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
long&nbsp;range,
int&nbsp;size,
boolean&nbsp;replace,
long&nbsp;seed)</code>
<div class="block">Generates a sample of size <code>size</code> from a range of values [1,range].</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#generateSequence-org.apache.sysds.runtime.matrix.data.MatrixBlock-double-double-double-">generateSequence</a></span>(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
double&nbsp;from,
double&nbsp;to,
double&nbsp;incr)</code>
<div class="block">Method to generate a sequence according to the given parameters.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#generateUniqueSeedPath-java.lang.String-">generateUniqueSeedPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;basedir)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#isShortcutRandOperation-double-double-double-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator.PDF-">isShortcutRandOperation</a></span>(double&nbsp;min,
double&nbsp;max,
double&nbsp;sparsity,
org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator.PDF&nbsp;pdf)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static org.apache.commons.math3.random.Well1024a</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#setupSeedsForRand-long-">setupSeedsForRand</a></span>(long&nbsp;seed)</code>
<div class="block">A matrix of random numbers is generated by using multiple seeds, one for each
block.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html#updateSeqIncr-double-double-double-">updateSeqIncr</a></span>(double&nbsp;seq_from,
double&nbsp;seq_to,
double&nbsp;seq_incr)</code>&nbsp;</td>
</tr>
</table>
<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</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">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</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">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">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isShortcutRandOperation-double-double-double-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator.PDF-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShortcutRandOperation</h4>
<pre>public static&nbsp;boolean&nbsp;isShortcutRandOperation(double&nbsp;min,
double&nbsp;max,
double&nbsp;sparsity,
org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator.PDF&nbsp;pdf)</pre>
</li>
</ul>
<a name="updateSeqIncr-double-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateSeqIncr</h4>
<pre>public static&nbsp;double&nbsp;updateSeqIncr(double&nbsp;seq_from,
double&nbsp;seq_to,
double&nbsp;seq_incr)</pre>
</li>
</ul>
<a name="generateUniqueSeedPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateUniqueSeedPath</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;generateUniqueSeedPath(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;basedir)</pre>
</li>
</ul>
<a name="setupSeedsForRand-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupSeedsForRand</h4>
<pre>public static&nbsp;org.apache.commons.math3.random.Well1024a&nbsp;setupSeedsForRand(long&nbsp;seed)</pre>
<div class="block">A matrix of random numbers is generated by using multiple seeds, one for each
block. Such block-level seeds are produced via Well equidistributed long-period linear
generator (Well1024a). For a given seed, this function sets up the block-level seeds.
This function is invoked from both CP (RandCPInstruction.processInstruction())
as well as MR (RandMR.java while setting up the Rand job).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>seed</code> - seed for random generator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Well1024a pseudo-random number generator</dd>
</dl>
</li>
</ul>
<a name="computeNNZperBlock-long-long-int-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeNNZperBlock</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/LongStream.html?is-external=true" title="class or interface in java.util.stream">LongStream</a>&nbsp;computeNNZperBlock(long&nbsp;nrow,
long&nbsp;ncol,
int&nbsp;blen,
double&nbsp;sparsity)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="createRandomMatrixGenerator-java.lang.String-int-int-int-double-double-double-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRandomMatrixGenerator</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a>&nbsp;createRandomMatrixGenerator(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pdfStr,
int&nbsp;r,
int&nbsp;c,
int&nbsp;blen,
double&nbsp;sp,
double&nbsp;min,
double&nbsp;max,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;distParams)</pre>
</li>
</ul>
<a name="generateRandomMatrix-org.apache.sysds.runtime.matrix.data.MatrixBlock-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator-org.apache.commons.math3.random.Well1024a-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateRandomMatrix</h4>
<pre>public static&nbsp;void&nbsp;generateRandomMatrix(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a>&nbsp;rgen,
org.apache.commons.math3.random.Well1024a&nbsp;bigrand,
long&nbsp;bSeed)</pre>
<div class="block">Function to generate a matrix of random numbers. This is invoked both
from CP as well as from MR. In case of CP, it generates an entire matrix
block-by-block. A <code>bigrand</code> is passed so that block-level
seeds are generated internally. In case of MR, it generates a single
block for given block-level seed <code>bSeed</code>.
When pdf="uniform", cell values are drawn from uniform distribution in
range <code>[min,max]</code>.
When pdf="normal", cell values are drawn from standard normal
distribution N(0,1). The range of generated values will always be
(-Inf,+Inf).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - output matrix block</dd>
<dd><code>rgen</code> - random matrix generator</dd>
<dd><code>bigrand</code> - Well1024a pseudo-random number generator</dd>
<dd><code>bSeed</code> - seed for random generator</dd>
</dl>
</li>
</ul>
<a name="generateRandomMatrix-org.apache.sysds.runtime.matrix.data.MatrixBlock-org.apache.sysds.runtime.matrix.data.RandomMatrixGenerator-org.apache.commons.math3.random.Well1024a-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateRandomMatrix</h4>
<pre>public static&nbsp;void&nbsp;generateRandomMatrix(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
<a href="../../../../../../org/apache/sysds/runtime/matrix/data/RandomMatrixGenerator.html" title="class in org.apache.sysds.runtime.matrix.data">RandomMatrixGenerator</a>&nbsp;rgen,
org.apache.commons.math3.random.Well1024a&nbsp;bigrand,
long&nbsp;bSeed,
int&nbsp;k)</pre>
<div class="block">Function to generate a matrix of random numbers. This is invoked both
from CP as well as from MR. In case of CP, it generates an entire matrix
block-by-block. A <code>bigrand</code> is passed so that block-level
seeds are generated internally. In case of MR, it generates a single
block for given block-level seed <code>bSeed</code>.
When pdf="uniform", cell values are drawn from uniform distribution in
range <code>[min,max]</code>.
When pdf="normal", cell values are drawn from standard normal
distribution N(0,1). The range of generated values will always be
(-Inf,+Inf).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - output matrix block</dd>
<dd><code>rgen</code> - random matrix generator</dd>
<dd><code>bigrand</code> - Well1024a pseudo-random number generator</dd>
<dd><code>bSeed</code> - seed for random generator</dd>
<dd><code>k</code> - ?</dd>
</dl>
</li>
</ul>
<a name="generateSequence-org.apache.sysds.runtime.matrix.data.MatrixBlock-double-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSequence</h4>
<pre>public static&nbsp;void&nbsp;generateSequence(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
double&nbsp;from,
double&nbsp;to,
double&nbsp;incr)</pre>
<div class="block">Method to generate a sequence according to the given parameters. The
generated sequence is always in dense format.
Both end points specified <code>from</code> and <code>to</code> must be
included in the generated sequence i.e., [from,to] both inclusive. Note
that, <code>to</code> is included only if (to-from) is perfectly
divisible by <code>incr</code>.
For example, seq(0,1,0.5) generates (0.0 0.5 1.0)
whereas seq(0,1,0.6) generates (0.0 0.6) but not (0.0 0.6 1.0)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - output matrix block</dd>
<dd><code>from</code> - lower end point</dd>
<dd><code>to</code> - upper end point</dd>
<dd><code>incr</code> - increment value</dd>
</dl>
</li>
</ul>
<a name="generateSample-org.apache.sysds.runtime.matrix.data.MatrixBlock-long-int-boolean-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateSample</h4>
<pre>public static&nbsp;void&nbsp;generateSample(<a href="../../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;out,
long&nbsp;range,
int&nbsp;size,
boolean&nbsp;replace,
long&nbsp;seed)</pre>
<div class="block">Generates a sample of size <code>size</code> from a range of values [1,range].
<code>replace</code> defines if sampling is done with or without replacement.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - output matrix block</dd>
<dd><code>range</code> - range upper bound</dd>
<dd><code>size</code> - sample size</dd>
<dd><code>replace</code> - if true, sample with replacement</dd>
<dd><code>seed</code> - seed for random generator</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/LibMatrixDatagen.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/sysds/runtime/matrix/data/LibMatrixCuMatMult.html" title="class in org.apache.sysds.runtime.matrix.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/sysds/runtime/matrix/data/LibMatrixDNN.html" title="class in org.apache.sysds.runtime.matrix.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/sysds/runtime/matrix/data/LibMatrixDatagen.html" target="_top">Frames</a></li>
<li><a href="LibMatrixDatagen.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>