Function applySemantics

  • applySemantics<
        Name extends
            | "join"
            | "unknown"
            | "read"
            | "create"
            | "accessCols"
            | "accessRows"
            | "assignCols"
            | "assignRows"
            | "setColNames"
            | "addCols"
            | "addRows"
            | "removeCols"
            | "removeRows"
            | "concatCols"
            | "concatRows"
            | "subsetCols"
            | "subsetRows"
            | "filterRows"
            | "mutateCols"
            | "groupBy"
            | "summarize"
            | "identity",
    >(
        operation: Name,
        value: DataFrameDomain,
        args: DataFrameOperationArgs<Name>,
        options?: DataFrameOperationOptions<Name>,
    ): DataFrameDomain

    Applies the abstract semantics of an abstract data frame operation with respect to the data frame shape domain. This expects that all arguments have already been sanitized according to the original concrete data frame function (e.g. by replacing duplicate/invalid column names).

    Type Parameters

    • Name extends
          | "join"
          | "unknown"
          | "read"
          | "create"
          | "accessCols"
          | "accessRows"
          | "assignCols"
          | "assignRows"
          | "setColNames"
          | "addCols"
          | "addRows"
          | "removeCols"
          | "removeRows"
          | "concatCols"
          | "concatRows"
          | "subsetCols"
          | "subsetRows"
          | "filterRows"
          | "mutateCols"
          | "groupBy"
          | "summarize"
          | "identity"

    Parameters

    • operation: Name

      The name of the abstract operation to apply the semantics of

    • value: DataFrameDomain

      The abstract data frame shape of the operand of the abstract operation

    • args: DataFrameOperationArgs<Name>

      The arguments for applying the abstract semantics of the abstract operation

    • Optionaloptions: DataFrameOperationOptions<Name>

      The optional additional options of the abstract operation

    Returns DataFrameDomain

    The resulting new data frame shape constraints. The semantic type of the resulting constraints depends on the ConstraintType of the abstract operation.

Settings

Member Visibility