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

- Packages that use ScalarObject
  Package | Description
  --- | ---
  org.apache.sysds.api.jmlc |
  org.apache.sysds.api.mlcontext |
  org.apache.sysds.hops.rewrite |
  org.apache.sysds.runtime.codegen |
  org.apache.sysds.runtime.compress |
  org.apache.sysds.runtime.controlprogram |
  org.apache.sysds.runtime.controlprogram.context |
  org.apache.sysds.runtime.controlprogram.federated |
  org.apache.sysds.runtime.instructions.cp |
  org.apache.sysds.runtime.lineage |
  org.apache.sysds.runtime.matrix.data |

- - ### Uses of ScalarObject in org.apache.sysds.api.jmlc

    Methods in org.apache.sysds.api.jmlc that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | ResultVariables.`getScalarObject(String varname)` Obtain the ScalarObject represented by the given output variable.

    Methods in org.apache.sysds.api.jmlc with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | PreparedScript.`setScalar(String varname, ScalarObject scalar, boolean reuse)` Binds a scalar object to a registered input variable.

  - ### Uses of ScalarObject in org.apache.sysds.api.mlcontext

    Methods in org.apache.sysds.api.mlcontext that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | MLResults.`getScalarObject(String outputName)` Obtain an output as a `Scalar` object.

  - ### Uses of ScalarObject in org.apache.sysds.hops.rewrite

    Methods in org.apache.sysds.hops.rewrite that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `static ScalarObject` | HopRewriteUtils.`getScalarObject(LiteralOp op)`

  - ### Uses of ScalarObject in org.apache.sysds.runtime.codegen

    Methods in org.apache.sysds.runtime.codegen that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars)`
    `ScalarObject` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects)`
    `ScalarObject` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars, int k)`
    `ScalarObject` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int numThreads)`
    `ScalarObject` | SpoofRowwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k)`
    `ScalarObject` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k)`
    `ScalarObject` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k, long rix)`

    Method parameters in org.apache.sysds.runtime.codegen with type arguments of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars)`
    `ScalarObject` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects)`
    `ScalarObject` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars, int k)`
    `ScalarObject` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int numThreads)`
    `ScalarObject` | SpoofRowwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k)`
    `ScalarObject` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k)`
    `ScalarObject` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, int k, long rix)`
    `abstract MatrixBlock` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars, MatrixBlock out)`
    `MatrixBlock` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out)`
    `MatrixBlock` | SpoofRowwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out)`
    `MatrixBlock` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out)`
    `MatrixBlock` | SpoofMultiAggregate.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out)`
    `MatrixBlock` | SpoofRowwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, boolean allocTmp, boolean aggIncr, long rix)`
    `MatrixBlock` | SpoofOperator.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalars, MatrixBlock out, int k)`
    `MatrixBlock` | SpoofOuterProduct.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int numThreads)`
    `MatrixBlock` | SpoofRowwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int k)`
    `MatrixBlock` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int k)`
    `MatrixBlock` | SpoofMultiAggregate.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int k)`
    `MatrixBlock` | SpoofCellwise.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int k, long rix)`
    `MatrixBlock` | SpoofMultiAggregate.`execute(ArrayList<MatrixBlock> inputs, ArrayList<ScalarObject> scalarObjects, MatrixBlock out, int k, long rix)`

  - ### Uses of ScalarObject in org.apache.sysds.runtime.compress

    Methods in org.apache.sysds.runtime.compress with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `MatrixBlock` | AbstractCompressedMatrixBlock.`leftIndexingOperations(ScalarObject scalar, int rl, int cl, MatrixBlock ret, MatrixObject.UpdateType update)`

  - ### Uses of ScalarObject in org.apache.sysds.runtime.controlprogram

    Methods in org.apache.sysds.runtime.controlprogram that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | ProgramBlock.`executePredicate(ArrayList<Instruction> inst, Hop hops, boolean requiresRecompile, Types.ValueType retType, ExecutionContext ec)` Executes given predicate instructions (incl recompilation if required)

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

    Methods in org.apache.sysds.runtime.controlprogram.context that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | ExecutionContext.`getScalarInput(CPOperand input)`
    `ScalarObject` | ExecutionContext.`getScalarInput(String name, Types.ValueType vt, boolean isLiteral)`

    Methods in org.apache.sysds.runtime.controlprogram.context that return types with arguments of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `List<ScalarObject>` | ExecutionContext.`getScalarInputs(CPOperand[] inputs)`

    Methods in org.apache.sysds.runtime.controlprogram.context with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | ExecutionContext.`setScalarOutput(String varName, ScalarObject so)`

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

    Methods in org.apache.sysds.runtime.controlprogram.federated that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `static ScalarObject` | FederationUtils.`aggScalar(AggregateUnaryOperator aop, Future<FederatedResponse>[] ffr)`

    Methods in org.apache.sysds.runtime.controlprogram.federated with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `FederatedRequest` | FederationMap.`broadcast(ScalarObject scalar)`

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

    Subclasses of ScalarObject in org.apache.sysds.runtime.instructions.cp
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BooleanObject`
    `class` | `DoubleObject`
    `class` | `IntObject`
    `class` | `StringObject`

    Methods in org.apache.sysds.runtime.instructions.cp that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(LiteralOp lit)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, double value)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, LiteralOp lit)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, Object obj)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, ScalarObject so)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, String value)`
    `ScalarObject` | CPOperand.`getLiteral()`

    Methods in org.apache.sysds.runtime.instructions.cp with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `static DoubleObject` | ScalarObjectFactory.`castToDouble(ScalarObject so)`
    `static IntObject` | ScalarObjectFactory.`castToLong(ScalarObject so)`
    `static LiteralOp` | ScalarObjectFactory.`createLiteralOp(ScalarObject so)`
    `static LiteralOp` | ScalarObjectFactory.`createLiteralOp(ScalarObject so, UnaryOp cast)`
    `static ScalarObject` | ScalarObjectFactory.`createScalarObject(Types.ValueType vt, ScalarObject so)`
    `String` | CPOperand.`getLineageLiteral(ScalarObject so)`
    `void` | CPOperand.`setLiteral(ScalarObject literal)`

    Constructors in org.apache.sysds.runtime.instructions.cp with parameters of type ScalarObject
    Constructor and Description
    `CPOperand(ScalarObject so)`

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

    Methods in org.apache.sysds.runtime.lineage that return ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `ScalarObject` | LineageCacheEntry.`getSOValue()`

    Methods in org.apache.sysds.runtime.lineage with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | LineageCacheEntry.`setValue(ScalarObject val, long computetime)`

    Constructors in org.apache.sysds.runtime.lineage with parameters of type ScalarObject
    Constructor and Description
    `LineageCacheEntry(LineageItem key, Types.DataType dt, MatrixBlock Mval, ScalarObject Sval, long computetime)`

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

    Methods in org.apache.sysds.runtime.matrix.data with parameters of type ScalarObject
    Modifier and Type | Method and Description
    --- | ---
    `MatrixBlock` | MatrixBlock.`leftIndexingOperations(ScalarObject scalar, int rl, int cl, MatrixBlock ret, MatrixObject.UpdateType update)` Explicitly allow left indexing for scalars.
    `static MatrixBlock` | MatrixBlock.`naryOperations(Operator op, MatrixBlock[] matrices, ScalarObject[] scalars, MatrixBlock ret)`

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