## Uses of Class
org.apache.sysds.runtime.instructions.cp.CPOperand

- Packages that use CPOperand
  Package | Description
  --- | ---
  org.apache.sysds.runtime.controlprogram.context |
  org.apache.sysds.runtime.controlprogram.federated |
  org.apache.sysds.runtime.instructions |
  org.apache.sysds.runtime.instructions.cp |
  org.apache.sysds.runtime.instructions.fed |
  org.apache.sysds.runtime.instructions.gpu |
  org.apache.sysds.runtime.instructions.spark |
  org.apache.sysds.runtime.lineage |
  org.apache.sysds.runtime.util |

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

    Methods in org.apache.sysds.runtime.controlprogram.context with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | ExecutionContext.`containsVariable​(CPOperand operand)` |
    `CacheableData<?>` | ExecutionContext.`getCacheableData​(CPOperand input)` |
    `FrameObject` | ExecutionContext.`getFrameObject​(CPOperand input)` |
    `LineageItem` | ExecutionContext.`getLineageItem​(CPOperand input)` |
    `ListObject` | ExecutionContext.`getListObject​(CPOperand input)` |
    `MatrixBlock` | ExecutionContext.`getMatrixInput​(CPOperand input)` |
    `List<MatrixBlock>` | ExecutionContext.`getMatrixInputs​(CPOperand[] inputs)` |
    `List<MatrixBlock>` | ExecutionContext.`getMatrixInputs​(CPOperand[] inputs, boolean includeList)` |
    `MatrixLineagePair` | ExecutionContext.`getMatrixLineagePair​(CPOperand cpo)` |
    `MatrixObject` | ExecutionContext.`getMatrixObject​(CPOperand input)` |
    `LineageItem` | ExecutionContext.`getOrCreateLineageItem​(CPOperand input)` |
    `ScalarObject` | ExecutionContext.`getScalarInput​(CPOperand input)` |
    `List<ScalarObject>` | ExecutionContext.`getScalarInputs​(CPOperand[] inputs)` |
    `Data` | ExecutionContext.`getVariable​(CPOperand operand)` |
    `boolean` | ExecutionContext.`isFederated​(CPOperand input)` |
    `boolean` | ExecutionContext.`isFederated​(CPOperand input, FTypes.FType type)` |
    `void` | ExecutionContext.`releaseMatrixInputs​(CPOperand[] inputs)` |
    `void` | ExecutionContext.`releaseMatrixInputs​(CPOperand[] inputs, boolean includeList)` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.controlprogram.federated

    Methods in org.apache.sysds.runtime.controlprogram.federated with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `static FederatedRequest[]` | FederationUtils.`callInstruction​(String[] inst, CPOperand varOldOut, long outputId, CPOperand[] varOldIn, long[] varNewIn, Types.ExecType type)` |
    `static FederatedRequest[]` | FederationUtils.`callInstruction​(String[] inst, CPOperand varOldOut, CPOperand[] varOldIn, long[] varNewIn)` |
    `static FederatedRequest` | FederationUtils.`callInstruction​(String inst, CPOperand varOldOut, long outputId, CPOperand[] varOldIn, long[] varNewIn, Types.ExecType type, boolean rmFedOutputFlag)` |
    `static FederatedRequest` | FederationUtils.`callInstruction​(String inst, CPOperand varOldOut, CPOperand[] varOldIn, long[] varNewIn)` |
    `static FederatedRequest` | FederationUtils.`callInstruction​(String inst, CPOperand varOldOut, CPOperand[] varOldIn, long[] varNewIn, boolean rmFedOutFlag)` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.instructions

    Methods in org.apache.sysds.runtime.instructions with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `static String` | InstructionUtils.`constructBinaryInstString​(String instString, String opcode, CPOperand op1, CPOperand op2, CPOperand out)` |
    `static String` | InstructionUtils.`constructTernaryString​(String instString, CPOperand op1, CPOperand op2, CPOperand op3, CPOperand out)` |
    `static String` | InstructionUtils.`constructUnaryInstString​(String instString, String opcode, CPOperand op1, CPOperand out)` |
    `static String` | InstructionUtils.`createOperand​(CPOperand operand)` |
    `static String` | InstructionUtils.`instructionStringFEDPrepare​(String inst, CPOperand varOldOut, long id, CPOperand[] varOldIn, long[] varNewIn, boolean rmFederatedOutput)` | Prepare instruction string for sending in a FederatedRequest as a CP instruction.
    `static Operator` | InstructionUtils.`parseBinaryOrBuiltinOperator​(String opcode, CPOperand in1, CPOperand in2)` |
    `static Operator` | InstructionUtils.`parseExtendedBinaryOrBuiltinOperator​(String opcode, CPOperand in1, CPOperand in2)` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.instructions.cp

    Fields in org.apache.sysds.runtime.instructions.cp declared as CPOperand
    Modifier and Type | Field | Description
    --- | --- | ---
    `CPOperand` | ComputationCPInstruction.`input1` |
    `CPOperand` | ComputationCPInstruction.`input2` |
    `CPOperand` | ComputationCPInstruction.`input3` |
    `CPOperand` | ComputationCPInstruction.`output` |

    Methods in org.apache.sysds.runtime.instructions.cp that return CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `CPOperand` | VariableCPInstruction.`getInput​(int index)` |
    `CPOperand` | VariableCPInstruction.`getInput1()` |
    `CPOperand` | VariableCPInstruction.`getInput2()` |
    `CPOperand` | VariableCPInstruction.`getInput3()` |
    `CPOperand` | QuaternaryCPInstruction.`getInput4()` |
    `CPOperand` | VariableCPInstruction.`getInput4()` |
    `CPOperand[]` | BuiltinNaryCPInstruction.`getInputs()` |
    `CPOperand[]` | ComputationCPInstruction.`getInputs()` |
    `CPOperand[]` | FunctionCallCPInstruction.`getInputs()` |
    `CPOperand[]` | SpoofCPInstruction.`getInputs()` |
    `CPOperand[]` | SqlCPInstruction.`getInputs()` | Returns the inputs of the instruction.
    `CPOperand` | BuiltinNaryCPInstruction.`getOutput()` |
    `CPOperand` | ComputationCPInstruction.`getOutput()` |
    `CPOperand` | MultiReturnBuiltinCPInstruction.`getOutput​(int i)` |
    `CPOperand` | MultiReturnParameterizedBuiltinCPInstruction.`getOutput​(int i)` |
    `CPOperand` | SqlCPInstruction.`getOutput()` |
    `CPOperand` | VariableCPInstruction.`getOutput()` |
    `CPOperand` | ListAppendRemoveCPInstruction.`getOutput2()` |

    Methods in org.apache.sysds.runtime.instructions.cp that return types with arguments of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `List<CPOperand>` | VariableCPInstruction.`getInputs()` |
    `List<CPOperand>` | MultiReturnBuiltinCPInstruction.`getOutputs()` |
    `List<CPOperand>` | MultiReturnParameterizedBuiltinCPInstruction.`getOutputs()` |

    Methods in org.apache.sysds.runtime.instructions.cp with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | VariableCPInstruction.`addInput​(CPOperand input)` |

    Constructors in org.apache.sysds.runtime.instructions.cp with parameters of type CPOperand
    Constructor | Description
    --- | ---
    `BuiltinNaryCPInstruction​(Operator op, String opcode, String istr, CPOperand output, CPOperand... inputs)` |
    `CPOperand​(CPOperand variable)` |
    `DataGenCPInstruction​(Operator op, Types.OpOpDG method, CPOperand out, CPOperand rows, CPOperand cols, String data, String schema, String opcode, String str)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand out, String opcode, String istr, int numThreads, double intermediateMemoryBudget)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand in3, CPOperand out, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget, String opcode, String istr)` |
    `DnnCPInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand in4, CPOperand in5, CPOperand in6, CPOperand in7, CPOperand in8, CPOperand out, CPOperand out2, CPOperand out3, CPOperand out4, CPOperand out5, String opcode, String istr, double intermediateMemoryBudget)` |
    `EvalNaryCPInstruction​(Operator op, String opcode, String istr, CPOperand output, CPOperand... inputs)` |
    `FunctionCallCPInstruction​(String namespace, String functName, boolean opt, CPOperand[] boundInputs, List<String> funArgNames, List<String> boundOutputNames, String istr)` |
    `FunctionCallCPInstruction​(String namespace, String functName, boolean opt, CPOperand[] boundInputs, LineageItem[] lineageInputs, List<String> funArgNames, List<String> boundOutputNames, String istr)` |
    `MatrixIndexingCPInstruction​(CPOperand in, CPOperand rl, CPOperand ru, CPOperand cl, CPOperand cu, CPOperand out, String opcode, String istr)` |
    `ParamservBuiltinCPInstruction​(Operator op, LinkedHashMap<String,​String> paramsMap, CPOperand out, String opcode, String istr)` |
    `SqlCPInstruction​(CPOperand conn, CPOperand user, CPOperand pass, CPOperand query, CPOperand out, String opcode, String instr)` |

    Constructor parameters in org.apache.sysds.runtime.instructions.cp with type arguments of type CPOperand
    Constructor | Description
    --- | ---
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget)` |
    `DnnCPInstruction​(CPOperand in, CPOperand in2, CPOperand in3, CPOperand out, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, int numThreads, double intermediateMemoryBudget, String opcode, String istr)` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.instructions.fed

    Fields in org.apache.sysds.runtime.instructions.fed declared as CPOperand
    Modifier and Type | Field | Description
    --- | --- | ---
    `CPOperand` | ComputationFEDInstruction.`input1` |
    `CPOperand` | ComputationFEDInstruction.`input2` |
    `CPOperand` | ComputationFEDInstruction.`input3` |
    `CPOperand` | ComputationFEDInstruction.`output` |

    Methods in org.apache.sysds.runtime.instructions.fed that return CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `CPOperand` | MultiReturnParameterizedBuiltinFEDInstruction.`getOutput​(int i)` |

    Methods in org.apache.sysds.runtime.instructions.fed with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `static boolean` | SpoofFEDInstruction.`isFederated​(ExecutionContext ec, FTypes.FType type, CPOperand[] inputs, Class<?> scla)` |
    `static boolean` | SpoofFEDInstruction.`isFederated​(ExecutionContext ec, CPOperand[] inputs, Class<?> scla)` |

    Constructors in org.apache.sysds.runtime.instructions.fed with parameters of type CPOperand
    Constructor | Description
    --- | ---
    `AggregateBinaryFEDInstruction​(Operator op, CPOperand in1, CPOperand in2, CPOperand out, String opcode, String istr)` |
    `AggregateBinaryFEDInstruction​(Operator op, CPOperand in1, CPOperand in2, CPOperand out, String opcode, String istr, FEDInstruction.FederatedOutput fedOut)` |
    `BinaryFEDInstruction​(FEDInstruction.FEDType type, Operator op, CPOperand in1, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr)` |
    `InitFEDInstruction​(CPOperand type, CPOperand addresses, CPOperand ranges, CPOperand out, String opcode, String instr)` |
    `InitFEDInstruction​(CPOperand type, CPOperand addresses, CPOperand ranges, CPOperand object, CPOperand out, String opcode, String instr)` |
    `MMChainFEDInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand out, MapMultChain.ChainType type, int k, String opcode, String istr)` |
    `QuantilePickFEDInstruction​(Operator op, CPOperand in, CPOperand out, PickByCount.OperationTypes type, boolean inmem, String opcode, String istr)` |
    `QuantilePickFEDInstruction​(Operator op, CPOperand in, CPOperand in2, CPOperand out, PickByCount.OperationTypes type, boolean inmem, String opcode, String istr)` |
    `QuantilePickFEDInstruction​(Operator op, CPOperand in, CPOperand in2, CPOperand out, PickByCount.OperationTypes type, boolean inmem, String opcode, String istr, FEDInstruction.FederatedOutput fedOut)` |
    `ReorgFEDInstruction​(Operator op, CPOperand in1, CPOperand out, String opcode, String istr)` |
    `ReorgFEDInstruction​(Operator op, CPOperand in1, CPOperand out, String opcode, String istr, FEDInstruction.FederatedOutput fedOut)` |
    `TsmmFEDInstruction​(CPOperand in, CPOperand out, MMTSJ.MMTSJType type, int k, String opcode, String istr)` |
    `TsmmFEDInstruction​(CPOperand in, CPOperand out, MMTSJ.MMTSJType type, int k, String opcode, String istr, FEDInstruction.FederatedOutput fedOut)` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.instructions.gpu

    Fields in org.apache.sysds.runtime.instructions.gpu declared as CPOperand
    Modifier and Type | Field | Description
    --- | --- | ---
    `CPOperand` | GPUInstruction.`_input1` |
    `CPOperand` | GPUInstruction.`_input2` |
    `CPOperand` | SpoofCUDAInstruction.`_out` |
    `CPOperand` | GPUInstruction.`_output` |

    Constructors in org.apache.sysds.runtime.instructions.gpu with parameters of type CPOperand
    Constructor | Description
    --- | ---
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand out, String opcode, String istr, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand in4, CPOperand out, String opcode, String istr, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in, CPOperand in2, CPOperand in3, CPOperand in4, CPOperand in5, CPOperand in6, CPOperand out, String opcode, String istr, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand in4, CPOperand in5, CPOperand in6, CPOperand out, CPOperand out2, String opcode, String istr, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand in4, CPOperand in5, CPOperand in6, CPOperand in7, CPOperand in8, CPOperand out, CPOperand out2, CPOperand out3, CPOperand out4, CPOperand out5, String opcode, String istr, double intermediateMemoryBudget)` |

    Constructor parameters in org.apache.sysds.runtime.instructions.gpu with type arguments of type CPOperand
    Constructor | Description
    --- | ---
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, double intermediateMemoryBudget)` |
    `DnnGPUInstruction​(CPOperand in1, CPOperand in2, CPOperand in3, CPOperand out, String opcode, String istr, ArrayList<CPOperand> stride, ArrayList<CPOperand> padding, ArrayList<CPOperand> input_shape, ArrayList<CPOperand> filter_shape, double intermediateMemoryBudget)` |

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

    Fields in org.apache.sysds.runtime.instructions.spark declared as CPOperand
    Modifier and Type | Field | Description
    --- | --- | ---
    `CPOperand` | ComputationSPInstruction.`input1` |
    `CPOperand` | WriteSPInstruction.`input1` |
    `CPOperand` | ComputationSPInstruction.`input2` |
    `CPOperand` | ComputationSPInstruction.`input3` |
    `CPOperand` | ComputationSPInstruction.`output` |

    Methods in org.apache.sysds.runtime.instructions.spark that return CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `CPOperand` | WriteSPInstruction.`getInput1()` |
    `CPOperand` | WriteSPInstruction.`getInput2()` |
    `CPOperand[]` | SpoofSPInstruction.`getInputs()` |

  - ### Uses of CPOperand in org.apache.sysds.runtime.lineage

    Methods in org.apache.sysds.runtime.lineage with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | Lineage.`contains​(CPOperand variable)` |
    `boolean` | LineageMap.`contains​(CPOperand variable)` |
    `LineageItem` | Lineage.`get​(CPOperand variable)` |
    `LineageItem` | LineageMap.`get​(CPOperand variable)` |
    `static LineageItem[]` | LineageItemUtils.`getLineage​(ExecutionContext ec, CPOperand... operands)` |
    `LineageItem` | Lineage.`getOrCreate​(CPOperand variable)` |
    `LineageItem` | LineageMap.`getOrCreate​(CPOperand variable)` |
    `static void` | LineageItemUtils.`replaceDagLeaves​(ExecutionContext ec, LineageItem root, CPOperand[] newLeaves)` |
    `String` | Lineage.`serializeSingleTrace​(CPOperand cpo)` |

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

    Methods in org.apache.sysds.runtime.util with parameters of type CPOperand
    Modifier and Type | Method | Description
    --- | --- | ---
    `static int[]` | DataConverter.`getTensorDimensions​(ExecutionContext ec, CPOperand dims)` |