org.apache.sysds.lops

## Class SortKeys

- java.lang.Object
- - org.apache.sysds.lops.Lop
  - - org.apache.sysds.lops.SortKeys

-     public class SortKeys
      extends Lop

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `SortKeys.OperationTypes`

    - ### Nested classes/interfaces inherited from class org.apache.sysds.lops.Lop

      `Lop.SimpleInstType, Lop.Type, Lop.VisitStatus`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `OPCODE`

    - ### Fields inherited from class org.apache.sysds.lops.Lop

      `_beginColumn, _beginLine, _endColumn, _endLine, _filename, CP_CHILD_THREAD, CP_ROOT_THREAD_ID, DATATYPE_PREFIX, FILE_SEPARATOR, FRAME_VAR_NAME_PREFIX, INSTRUCTION_DELIMITOR, LITERAL_PREFIX, MATRIX_VAR_NAME_PREFIX, NAME_VALUE_SEPARATOR, OPERAND_DELIMITOR, PROCESS_PREFIX, SAMPLE_FRACTION, SCALAR_VAR_NAME_PREFIX, UPDATE_INPLACE_PREFIX, VALUETYPE_PREFIX, VARIABLE_NAME_PLACEHOLDER`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SortKeys(Lop input, boolean desc, SortKeys.OperationTypes op, Types.DataType dt, Types.ValueType vt, Types.ExecType et)`
    `SortKeys(Lop input1, Lop input2, SortKeys.OperationTypes op, Types.DataType dt, Types.ValueType vt, Types.ExecType et)`
    `SortKeys(Lop input, SortKeys.OperationTypes op, Types.DataType dt, Types.ValueType vt, Types.ExecType et)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static SortKeys` | `constructSortByValueLop(Lop input1, Lop input2, SortKeys.OperationTypes op, Types.DataType dt, Types.ValueType vt, Types.ExecType et)`
    `static SortKeys` | `constructSortByValueLop(Lop input1, SortKeys.OperationTypes op, Types.DataType dt, Types.ValueType vt, Types.ExecType et)`
    `String` | `getInstructions(String input, String output)` Method should be overridden if needed
    `String` | `getInstructions(String input1, String input2, String output)` Method should be overridden if needed
    `SortKeys.OperationTypes` | `getOpType()`
    `String` | `toString()` Method to have Lops print their state.

    - ### Methods inherited from class org.apache.sysds.lops.Lop

      `addInput, addOutput, addToDag, createReachable, getBeginColumn, getBeginLine, getDataType, getEndColumn, getEndLine, getExecType, getFilename, getID, getInputs, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getInstructions, getLevel, getOutputParameters, getOutputs, getPrivacyConstraint, getProducesIntermediateOutput, getReachable, getSimpleInstructionType, getType, getValueType, getVisited, isDataExecLocation, isVariable, prepInputOperand, prepInputOperand, prepOperand, prepOperand, prepOutputOperand, prepOutputOperand, prepOutputOperand, prepScalarInputOperand, prepScalarInputOperand, prepScalarLabel, prepScalarOperand, printErrorLocation, removeConsumer, resetVisitStatus, setAllPositions, setBeginColumn, setBeginLine, setConsumerCount, setDataType, setEndColumn, setEndLine, setExecType, setFederatedOutput, setFilename, setPrivacyConstraint, setValueType, setVisited`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### OPCODE

          public static final String OPCODE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SortKeys

          public SortKeys(Lop input,
                          SortKeys.OperationTypes op,
                          Types.DataType dt,
                          Types.ValueType vt,
                          Types.ExecType et)

    - #### SortKeys

          public SortKeys(Lop input,
                          boolean desc,
                          SortKeys.OperationTypes op,
                          Types.DataType dt,
                          Types.ValueType vt,
                          Types.ExecType et)

    - #### SortKeys

          public SortKeys(Lop input1,
                          Lop input2,
                          SortKeys.OperationTypes op,
                          Types.DataType dt,
                          Types.ValueType vt,
                          Types.ExecType et)

  - ### Method Detail

    - #### getOpType

          public SortKeys.OperationTypes getOpType()

    - #### toString

          public String toString()

      Description copied from class: `Lop`
      Method to have Lops print their state. This is for debugging purposes.
      Specified by:
        `toString` in class `Lop`

    - #### getInstructions

          public String getInstructions(String input,
                                        String output)

      Description copied from class: `Lop`
      Method should be overridden if needed
      Overrides:
        `getInstructions` in class `Lop`
      Parameters:
        `input` - input 1
        `output` - output
      Returns:
        instructions as string

    - #### getInstructions

          public String getInstructions(String input1,
                                        String input2,
                                        String output)

      Description copied from class: `Lop`
      Method should be overridden if needed
      Overrides:
        `getInstructions` in class `Lop`
      Parameters:
        `input1` - input 1
        `input2` - input 2
        `output` - output
      Returns:
        instructions as string

    - #### constructSortByValueLop

          public static SortKeys constructSortByValueLop(Lop input1,
                                                         SortKeys.OperationTypes op,
                                                         Types.DataType dt,
                                                         Types.ValueType vt,
                                                         Types.ExecType et)

    - #### constructSortByValueLop

          public static SortKeys constructSortByValueLop(Lop input1,
                                                         Lop input2,
                                                         SortKeys.OperationTypes op,
                                                         Types.DataType dt,
                                                         Types.ValueType vt,
                                                         Types.ExecType et)

Copyright © 2021 The Apache Software Foundation. All rights reserved.