## Uses of Class
org.apache.sysds.runtime.matrix.data.Pair

- Packages that use Pair
  Package | Description
  --- | ---
  org.apache.sysds.hops.codegen.template |
  org.apache.sysds.runtime.controlprogram.context |
  org.apache.sysds.runtime.functionobjects |
  org.apache.sysds.runtime.instructions.spark.data |
  org.apache.sysds.runtime.instructions.spark.utils |
  org.apache.sysds.runtime.iogen |
  org.apache.sysds.runtime.matrix.data |
  org.apache.sysds.runtime.transform.decode |
  org.apache.sysds.runtime.transform.meta |
  org.apache.sysds.runtime.util |

- - ### Uses of Pair in org.apache.sysds.hops.codegen.template

    Methods in org.apache.sysds.hops.codegen.template that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `abstract Pair<Hop[],​CNodeTpl>` | TemplateBase.`constructCplan​(Hop hop, CPlanMemoTable memo, boolean compileLiterals)` | Constructs a single cplan rooted at the given hop, according to the plan given in the memo structure for this particular hop and its recursive inputs.
    `Pair<Hop[],​CNodeTpl>` | TemplateCell.`constructCplan​(Hop hop, CPlanMemoTable memo, boolean compileLiterals)` |
    `Pair<Hop[],​CNodeTpl>` | TemplateMultiAgg.`constructCplan​(Hop hop, CPlanMemoTable memo, boolean compileLiterals)` |
    `Pair<Hop[],​CNodeTpl>` | TemplateOuterProduct.`constructCplan​(Hop hop, CPlanMemoTable memo, boolean compileLiterals)` |
    `Pair<Hop[],​CNodeTpl>` | TemplateRow.`constructCplan​(Hop hop, CPlanMemoTable memo, boolean compileLiterals)` |

  - ### Uses of Pair in org.apache.sysds.runtime.controlprogram.context

    Methods in org.apache.sysds.runtime.controlprogram.context that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pair<MatrixObject,​Boolean>` | ExecutionContext.`getDenseMatrixOutputForGPUInstruction​(String varName, long numRows, long numCols)` | Allocates a dense matrix on the GPU (for output)
    `Pair<MatrixObject,​Boolean>` | ExecutionContext.`getDenseMatrixOutputForGPUInstruction​(String varName, long numRows, long numCols, boolean initialize)` |
    `Pair<MatrixObject,​Boolean>` | ExecutionContext.`getSparseMatrixOutputForGPUInstruction​(String varName, long numRows, long numCols, long nnz)` | Allocates a sparse matrix in CSR format on the GPU.
    `Pair<MatrixObject,​Boolean>` | ExecutionContext.`getSparseMatrixOutputForGPUInstruction​(String varName, long numRows, long numCols, long nnz, boolean initialize)` |

  - ### Uses of Pair in org.apache.sysds.runtime.functionobjects

    Methods in org.apache.sysds.runtime.functionobjects that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pair<MatrixIndexes,​Double>` | CTable.`execute​(long row, double v2, double w)` |

  - ### Uses of Pair in org.apache.sysds.runtime.instructions.spark.data

    Method parameters in org.apache.sysds.runtime.instructions.spark.data with type arguments of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | FrameReblockBuffer.`flushBufferToBinaryBlocks​(ArrayList<Pair<Long,​FrameBlock>> outList)` |

  - ### Uses of Pair in org.apache.sysds.runtime.instructions.spark.utils

    Methods in org.apache.sysds.runtime.instructions.spark.utils that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pair<MatrixIndexes,​MatrixBlock>` | SparkUtils.`fromIndexedMatrixBlockToPair​(IndexedMatrixValue in)` |
    `static Pair<Long,​FrameBlock>` | SparkUtils.`toIndexedFrameBlock​(scala.Tuple2<Long,​FrameBlock> in)` |

    Methods in org.apache.sysds.runtime.instructions.spark.utils that return types with arguments of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static List<Pair<MatrixIndexes,​MatrixBlock>>` | SparkUtils.`fromIndexedMatrixBlockToPair​(List<IndexedMatrixValue> in)` |
    `static List<Pair<Long,​Long>>` | SparkUtils.`toIndexedLong​(List<scala.Tuple2<Long,​Long>> in)` |

    Methods in org.apache.sysds.runtime.instructions.spark.utils with parameters of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static org.apache.spark.api.java.JavaPairRDD<Long,​FrameBlock>` | FrameRDDConverterUtils.`dataFrameToBinaryBlock​(org.apache.spark.api.java.JavaSparkContext sc, org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> df, DataCharacteristics mc, boolean containsID, Pair<String[],​Types.ValueType[]> out)` |
    `static scala.Tuple2<Long,​FrameBlock>` | SparkUtils.`fromIndexedFrameBlock​(Pair<Long,​FrameBlock> in)` |

    Method parameters in org.apache.sysds.runtime.instructions.spark.utils with type arguments of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static List<scala.Tuple2<Long,​FrameBlock>>` | SparkUtils.`fromIndexedFrameBlock​(List<Pair<Long,​FrameBlock>> in)` |

  - ### Uses of Pair in org.apache.sysds.runtime.iogen

    Methods in org.apache.sysds.runtime.iogen that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pair<Integer,​Integer>` | RawRow.`findAtValue​(ValueTrimFormat vtf, int rawIndex, int numericIndex)` |
    `Pair<Integer,​Integer>` | RawRow.`findAtValue​(ValueTrimFormat vtf, int rawIndex, int numericIndex, boolean update)` |
    `Pair<Integer,​Integer>` | RawRow.`findSequenceValues​(ArrayList<ValueTrimFormat> vtfs, int startIndex, boolean update)` |
    `Pair<Integer,​Integer>` | RawRow.`findValue​(ValueTrimFormat vtf, boolean forward)` |
    `Pair<Integer,​Integer>` | RawRow.`findValue​(ValueTrimFormat vtf, boolean forward, boolean update)` |
    `Pair<String,​String>` | RawRow.`getDelims()` |
    `Pair<HashSet<String>,​Integer>` | RawRow.`getDelimsSet()` |

  - ### Uses of Pair in org.apache.sysds.runtime.matrix.data

    Methods in org.apache.sysds.runtime.matrix.data that return Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pair<org.apache.hadoop.io.NullWritable,​org.apache.hadoop.io.Text>` | BinaryBlockToTextCellConverter.`next()` |
    `Pair<K2,​V2>` | Converter.`next()` |
    `Pair<MatrixIndexes,​MatrixCell>` | TextToBinaryCellConverter.`next()` |

    Methods in org.apache.sysds.runtime.matrix.data that return types with arguments of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static ArrayList<Pair<Long,​FrameBlock>>` | OperationsOnMatrixValues.`performSlice​(Pair<Long,​FrameBlock> in, IndexRange ixrange, int blen)` | This function will get slice of the input frame block overlapping in overall slice(Range), slice has requested for.

    Methods in org.apache.sysds.runtime.matrix.data with parameters of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | OperationsOnMatrixValues.`performShift​(Pair<Long,​FrameBlock> in, IndexRange ixrange, int blenLeft, long rlen, long clen, ArrayList<Pair<Long,​FrameBlock>> outlist)` |
    `static ArrayList<Pair<Long,​FrameBlock>>` | OperationsOnMatrixValues.`performSlice​(Pair<Long,​FrameBlock> in, IndexRange ixrange, int blen)` | This function will get slice of the input frame block overlapping in overall slice(Range), slice has requested for.

    Method parameters in org.apache.sysds.runtime.matrix.data with type arguments of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | OperationsOnMatrixValues.`performShift​(Pair<Long,​FrameBlock> in, IndexRange ixrange, int blenLeft, long rlen, long clen, ArrayList<Pair<Long,​FrameBlock>> outlist)` |
    `void` | FrameBlock.`slice​(ArrayList<Pair<Long,​FrameBlock>> outlist, IndexRange range, int rowCut)` |

  - ### Uses of Pair in org.apache.sysds.runtime.transform.decode

    Methods in org.apache.sysds.runtime.transform.decode with parameters of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | DecoderRecode.`parseRecodeMapEntry​(String entry, Pair<String,​String> pair)` | Parses a line of <token, ID, count> into <token, ID> pairs, where quoted tokens (potentially including separators) are supported.

  - ### Uses of Pair in org.apache.sysds.runtime.transform.meta

    Constructor parameters in org.apache.sysds.runtime.transform.meta with type arguments of type Pair
    Constructor | Description
    --- | ---
    `TfOffsetMap​(List<Pair<Long,​Long>> rmRows)` |

  - ### Uses of Pair in org.apache.sysds.runtime.util

    Methods in org.apache.sysds.runtime.util with parameters of type Pair
    Modifier and Type | Method | Description
    --- | --- | ---
    `static IndexRange` | UtilFunctions.`getSelectedRangeForZeroOut​(Pair<Long,​FrameBlock> in, int blen, IndexRange indexRange, long lSrcRowIndex, long lDestRowIndex)` |
    `static int` | LocalFileUtils.`readBlockSequenceFromLocal​(String fname, Pair<MatrixIndexes,​MatrixValue>[] outValues, HashMap<MatrixIndexes,​Integer> outMap)` |
    `static void` | LocalFileUtils.`writeBlockSequenceToLocal​(String fname, Pair<MatrixIndexes,​MatrixValue>[] inValues, int len)` |