Package org.apache.sysds.runtime.instructions.fed

## Class ComputationFEDInstruction

- java.lang.Object
- - org.apache.sysds.runtime.instructions.Instruction
  - - org.apache.sysds.runtime.instructions.fed.FEDInstruction
    - - org.apache.sysds.runtime.instructions.fed.ComputationFEDInstruction

- All Implemented Interfaces:
    `LineageTraceable`
  Direct Known Subclasses:
    `AggregateTernaryFEDInstruction`, `BinaryFEDInstruction`, `CtableFEDInstruction`, `MultiReturnParameterizedBuiltinFEDInstruction`, `ParameterizedBuiltinFEDInstruction`, `QuaternaryFEDInstruction`, `TernaryFEDInstruction`, `UnaryFEDInstruction`

      public abstract class ComputationFEDInstruction
      extends FEDInstruction
      implements LineageTraceable

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.sysds.runtime.instructions.fed.FEDInstruction

      `FEDInstruction.FederatedOutput, FEDInstruction.FEDType`

    - ### Nested classes/interfaces inherited from class org.apache.sysds.runtime.instructions.Instruction

      `Instruction.IType`

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `CPOperand` | `input1` |
    `CPOperand` | `input2` |
    `CPOperand` | `input3` |
    `CPOperand` | `output` |

    - ### Fields inherited from class org.apache.sysds.runtime.instructions.Instruction

      `DATATYPE_PREFIX, FEDERATED_INST_PREFIX, GPU_INST_PREFIX, INSTRUCTION_DELIM, LITERAL_PREFIX, OPERAND_DELIM, SP_INST_PREFIX, VALUETYPE_PREFIX`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `org.apache.commons.lang3.tuple.Pair<String,​LineageItem>` | `getLineageItem​(ExecutionContext ec)` | Obtain lineage trace of an instruction with a single output.
    `String` | `getOutputVariableName()` |

    - ### Methods inherited from class org.apache.sysds.runtime.instructions.fed.FEDInstruction

      `getFEDInstructionType, getTID, getType, preprocessInstruction, setTID`

    - ### Methods inherited from class org.apache.sysds.runtime.instructions.Instruction

      `getBeginColumn, getBeginLine, getEndColumn, getEndLine, getExtendedOpcode, getFilename, getGraphString, getInstID, getInstructionString, getLineNum, getOpcode, getOperator, getPrivacyConstraint, postprocessInstruction, printMe, processInstruction, requiresLabelUpdate, setInstID, setLocation, setLocation, setLocation, setLocation, setPrivacyConstraint, setPrivacyConstraint, toString, updateInstructionThreadID`

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

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

    - ### Methods inherited from interface org.apache.sysds.runtime.lineage.LineageTraceable

      `getLineageItems, hasSingleLineage`

- - ### Field Detail

    - #### output

          public final CPOperand output

    - #### input1

          public final CPOperand input1

    - #### input2

          public final CPOperand input2

    - #### input3

          public final CPOperand input3

  - ### Method Detail

    - #### getOutputVariableName

          public String getOutputVariableName()

    - #### getLineageItem

          public org.apache.commons.lang3.tuple.Pair<String,​LineageItem> getLineageItem​(ExecutionContext ec)

      Description copied from interface: `LineageTraceable`
      Obtain lineage trace of an instruction with a single output.
      Specified by:
        `getLineageItem` in interface `LineageTraceable`
      Parameters:
        `ec` - execution context w/ live variables
      Returns:
        pair of (output variable name, output lineage item)