| <!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>Matrix (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="Matrix (SystemDS 2.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All 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/Matrix.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/api/mlcontext/FrameSchema.html" title="class in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/MatrixFormat.html" title="enum in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/Matrix.html" target="_top">Frames</a></li> |
| <li><a href="Matrix.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.api.mlcontext</div> |
| <h2 title="Class Matrix" class="title">Class Matrix</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.api.mlcontext.Matrix</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Matrix</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> |
| <div class="block">Matrix encapsulates a SystemDS matrix. It allows for easy conversion to |
| various other formats, such as RDDs, JavaRDDs, DataFrames, and double[][]s. |
| After script execution, it offers a convenient format for obtaining SystemDS |
| matrix data in Scala tuples.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/sysds/api/mlcontext/Matrix.html#Matrix-org.apache.spark.sql.Dataset-">Matrix</a></span>(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame)</code> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#Matrix-org.apache.spark.sql.Dataset-long-long-">Matrix</a></span>(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, |
| long numRows, |
| long numCols)</code> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation, |
| specifying the number of rows and columns.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#Matrix-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.MatrixMetadata-">Matrix</a></span>(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a> matrixMetadata)</code> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#Matrix-org.apache.spark.api.java.JavaPairRDD-org.apache.sysds.api.mlcontext.MatrixMetadata-">Matrix</a></span>(org.apache.spark.api.java.JavaPairRDD<<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixIndexes.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixIndexes</a>,<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>> binaryBlocks, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a> matrixMetadata)</code> |
| <div class="block">Create a Matrix, specifying the SystemDS binary-block matrix and its |
| metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#Matrix-org.apache.sysds.runtime.controlprogram.caching.MatrixObject-org.apache.sysds.runtime.controlprogram.context.SparkExecutionContext-">Matrix</a></span>(<a href="../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a> matrixObject, |
| <a href="../../../../../org/apache/sysds/runtime/controlprogram/context/SparkExecutionContext.html" title="class in org.apache.sysds.runtime.controlprogram.context">SparkExecutionContext</a> sparkExecutionContext)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#getMatrixMetadata--">getMatrixMetadata</a></span>()</code> |
| <div class="block">Obtain the matrix metadata</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#hasBinaryBlocks--">hasBinaryBlocks</a></span>()</code> |
| <div class="block">Whether or not this matrix contains data as binary blocks</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#hasMatrixObject--">hasMatrixObject</a></span>()</code> |
| <div class="block">Whether or not this matrix contains data as a MatrixObject</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>double[][]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#to2DDoubleArray--">to2DDoubleArray</a></span>()</code> |
| <div class="block">Obtain the matrix as a two-dimensional double array</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.api.java.JavaPairRDD<<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixIndexes.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixIndexes</a>,<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toBinaryBlocks--">toBinaryBlocks</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>JavaPairRDD<MatrixIndexes, MatrixBlock></code></div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toDF--">toDF</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with an ID column</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toDFDoubleNoIDColumn--">toDFDoubleNoIDColumn</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with no ID column</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toDFDoubleWithIDColumn--">toDFDoubleWithIDColumn</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with an ID column</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toDFVectorNoIDColumn--">toDFVectorNoIDColumn</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of vectors with no ID column</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toDFVectorWithIDColumn--">toDFVectorWithIDColumn</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of vectors with an ID column</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.api.java.JavaRDD<<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/api/mlcontext/Matrix.html#toJavaRDDStringCSV--">toJavaRDDStringCSV</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>JavaRDD<String></code> in CSV format</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.api.java.JavaRDD<<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/api/mlcontext/Matrix.html#toJavaRDDStringIJV--">toJavaRDDStringIJV</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>JavaRDD<String></code> in IJV format</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toMatrixBlock--">toMatrixBlock</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>MatrixBlock</code></div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/mlcontext/Matrix.html#toMatrixObject--">toMatrixObject</a></span>()</code> |
| <div class="block">Obtain the matrix as a SystemDS MatrixObject.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.rdd.RDD<<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/api/mlcontext/Matrix.html#toRDDStringCSV--">toRDDStringCSV</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>RDD<String></code> in CSV format</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.rdd.RDD<<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/api/mlcontext/Matrix.html#toRDDStringIJV--">toRDDStringIJV</a></span>()</code> |
| <div class="block">Obtain the matrix as a <code>RDD<String></code> in IJV format</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><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/api/mlcontext/Matrix.html#toString--">toString</a></span>()</code> |
| <div class="block">If <code>MatrixObject</code> is available, output |
| <code>MatrixObject.toString()</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Matrix-org.apache.sysds.runtime.controlprogram.caching.MatrixObject-org.apache.sysds.runtime.controlprogram.context.SparkExecutionContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Matrix</h4> |
| <pre>public Matrix(<a href="../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a> matrixObject, |
| <a href="../../../../../org/apache/sysds/runtime/controlprogram/context/SparkExecutionContext.html" title="class in org.apache.sysds.runtime.controlprogram.context">SparkExecutionContext</a> sparkExecutionContext)</pre> |
| </li> |
| </ul> |
| <a name="Matrix-org.apache.spark.sql.Dataset-org.apache.sysds.api.mlcontext.MatrixMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Matrix</h4> |
| <pre>public Matrix(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a> matrixMetadata)</pre> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataFrame</code> - the Spark DataFrame</dd> |
| <dd><code>matrixMetadata</code> - matrix metadata, such as number of rows and columns</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Matrix-org.apache.spark.sql.Dataset-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Matrix</h4> |
| <pre>public Matrix(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, |
| long numRows, |
| long numCols)</pre> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation, |
| specifying the number of rows and columns.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataFrame</code> - the Spark DataFrame</dd> |
| <dd><code>numRows</code> - the number of rows</dd> |
| <dd><code>numCols</code> - the number of columns</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Matrix-org.apache.spark.api.java.JavaPairRDD-org.apache.sysds.api.mlcontext.MatrixMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Matrix</h4> |
| <pre>public Matrix(org.apache.spark.api.java.JavaPairRDD<<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixIndexes.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixIndexes</a>,<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>> binaryBlocks, |
| <a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a> matrixMetadata)</pre> |
| <div class="block">Create a Matrix, specifying the SystemDS binary-block matrix and its |
| metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>binaryBlocks</code> - the <code>JavaPairRDD<MatrixIndexes, MatrixBlock></code> matrix</dd> |
| <dd><code>matrixMetadata</code> - matrix metadata, such as number of rows and columns</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Matrix-org.apache.spark.sql.Dataset-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Matrix</h4> |
| <pre>public Matrix(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame)</pre> |
| <div class="block">Convert a Spark DataFrame to a SystemDS binary-block representation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataFrame</code> - the Spark DataFrame</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="toMatrixObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMatrixObject</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/runtime/controlprogram/caching/MatrixObject.html" title="class in org.apache.sysds.runtime.controlprogram.caching">MatrixObject</a> toMatrixObject()</pre> |
| <div class="block">Obtain the matrix as a SystemDS MatrixObject.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a SystemDS MatrixObject</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="to2DDoubleArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to2DDoubleArray</h4> |
| <pre>public double[][] to2DDoubleArray()</pre> |
| <div class="block">Obtain the matrix as a two-dimensional double array</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a two-dimensional double array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJavaRDDStringIJV--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJavaRDDStringIJV</h4> |
| <pre>public org.apache.spark.api.java.JavaRDD<<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>> toJavaRDDStringIJV()</pre> |
| <div class="block">Obtain the matrix as a <code>JavaRDD<String></code> in IJV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>JavaRDD<String></code> in IJV format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJavaRDDStringCSV--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJavaRDDStringCSV</h4> |
| <pre>public org.apache.spark.api.java.JavaRDD<<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>> toJavaRDDStringCSV()</pre> |
| <div class="block">Obtain the matrix as a <code>JavaRDD<String></code> in CSV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>JavaRDD<String></code> in CSV format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toRDDStringCSV--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toRDDStringCSV</h4> |
| <pre>public org.apache.spark.rdd.RDD<<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>> toRDDStringCSV()</pre> |
| <div class="block">Obtain the matrix as a <code>RDD<String></code> in CSV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>RDD<String></code> in CSV format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toRDDStringIJV--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toRDDStringIJV</h4> |
| <pre>public org.apache.spark.rdd.RDD<<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>> toRDDStringIJV()</pre> |
| <div class="block">Obtain the matrix as a <code>RDD<String></code> in IJV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>RDD<String></code> in IJV format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDF--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDF</h4> |
| <pre>public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDF()</pre> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with an ID column</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>DataFrame</code> of doubles with an ID column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDFDoubleWithIDColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDFDoubleWithIDColumn</h4> |
| <pre>public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFDoubleWithIDColumn()</pre> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with an ID column</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>DataFrame</code> of doubles with an ID column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDFDoubleNoIDColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDFDoubleNoIDColumn</h4> |
| <pre>public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFDoubleNoIDColumn()</pre> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of doubles with no ID column</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>DataFrame</code> of doubles with no ID column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDFVectorWithIDColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDFVectorWithIDColumn</h4> |
| <pre>public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFVectorWithIDColumn()</pre> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of vectors with an ID column</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>DataFrame</code> of vectors with an ID column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toDFVectorNoIDColumn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toDFVectorNoIDColumn</h4> |
| <pre>public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFVectorNoIDColumn()</pre> |
| <div class="block">Obtain the matrix as a <code>DataFrame</code> of vectors with no ID column</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>DataFrame</code> of vectors with no ID column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toBinaryBlocks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBinaryBlocks</h4> |
| <pre>public org.apache.spark.api.java.JavaPairRDD<<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixIndexes.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixIndexes</a>,<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>> toBinaryBlocks()</pre> |
| <div class="block">Obtain the matrix as a <code>JavaPairRDD<MatrixIndexes, MatrixBlock></code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>JavaPairRDD<MatrixIndexes, MatrixBlock></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toMatrixBlock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMatrixBlock</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a> toMatrixBlock()</pre> |
| <div class="block">Obtain the matrix as a <code>MatrixBlock</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix as a <code>MatrixBlock</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMatrixMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatrixMetadata</h4> |
| <pre>public <a href="../../../../../org/apache/sysds/api/mlcontext/MatrixMetadata.html" title="class in org.apache.sysds.api.mlcontext">MatrixMetadata</a> getMatrixMetadata()</pre> |
| <div class="block">Obtain the matrix metadata</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <div class="block">If <code>MatrixObject</code> is available, output |
| <code>MatrixObject.toString()</code>. If <code>MatrixObject</code> is not available |
| but <code>MatrixMetadata</code> is available, output |
| <code>MatrixMetadata.toString()</code>. Otherwise output |
| <code>Object.toString()</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasBinaryBlocks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasBinaryBlocks</h4> |
| <pre>public boolean hasBinaryBlocks()</pre> |
| <div class="block">Whether or not this matrix contains data as binary blocks</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if data as binary blocks are present, <code>false</code> |
| otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasMatrixObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hasMatrixObject</h4> |
| <pre>public boolean hasMatrixObject()</pre> |
| <div class="block">Whether or not this matrix contains data as a MatrixObject</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if data as binary blocks are present, <code>false</code> |
| otherwise.</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/Matrix.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/api/mlcontext/FrameSchema.html" title="class in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sysds/api/mlcontext/MatrixFormat.html" title="enum in org.apache.sysds.api.mlcontext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sysds/api/mlcontext/Matrix.html" target="_top">Frames</a></li> |
| <li><a href="Matrix.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
