CONDITIONAL

Compare two given Scalar inputs. We are planning to add support for more DataContainer types in the future. It then enqueues nodes connected with a "true" or "false" output based on the comparison result. Params: operator_type : select Specifies the type of comparison to be performed between the two inputs. The default value is ">=". Returns: true : DataContainer Forwards the first value to the true branch. False : DataContainer Forwards the second value to the false branch.

Python Code

from typing import Any, Literal, TypedDict

from flojoy import JobResultBuilder, Scalar, flojoy


class ConditionalOutput(TypedDict):
    true: Any
    false: Any


@flojoy
def CONDITIONAL(
    x: Scalar,
    y: Scalar,
    operator_type: Literal["<=", ">", "<", ">=", "!=", "=="] = ">=",
) -> ConditionalOutput:
    """Compare two given Scalar inputs.

    We are planning to add support for more DataContainer types in the future.

    It then enqueues nodes connected with a "true" or "false" output based on the comparison result.

    Parameters
    ----------
    operator_type : select
        Specifies the type of comparison to be performed between the two inputs. The default value is ">=".

    Returns
    -------
    true : DataContainer
        Forwards the first value to the true branch.
    False : DataContainer
        Forwards the second value to the false branch.
    """

    # y_of_x = x.y
    # y_of_y = y.y

    bool_ = compare_values(x.c, y.c, operator_type)
    data = None
    if bool_:
        data = x
    else:
        data = y

    # if operator_type in ["<=", "<"]:
    #     if not bool_:
    #         data = OrderedPair(x=x.x, y=y.y)
    #     else:
    #         data = OrderedPair(x=y.x, y=x.y)
    # elif bool_:
    #     data = OrderedPair(x=x.x, y=y.y)
    # else:
    #     data = OrderedPair(x=y.x, y=x.y)

    next_direction = str(bool_).lower()

    return ConditionalOutput(
        true=JobResultBuilder()
        .from_data(data)
        .flow_to_directions([next_direction])
        .build(),
        false=JobResultBuilder()
        .from_data(data)
        .flow_to_directions([next_direction])
        .build(),
    )


def compare_values(first_value: Any, second_value: Any, operator: str):
    bool_: bool = False
    if operator == "<=":
        bool_ = first_value <= second_value
    elif operator == ">":
        bool_ = first_value > second_value
    elif operator == "<":
        bool_ = first_value < second_value
    elif operator == ">=":
        bool_ = first_value >= second_value
    elif operator == "!=":
        bool_ = first_value != second_value
    else:
        bool_ = first_value == second_value
    return bool_

Find this Flojoy Block on GitHub

Example

Having problems with this example app? Join our Discord community and we will help you out!

Press enter or space to select a node.You can then use the arrow keys to move the node around. Press delete to remove it and escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or escape to cancel.

Download this Flojoy App

In this example, we begin with two CONSTANT nodes initialized with values 8 and 4. These nodes are connected to the X and Y inputs of the CONDITIONAL node, allowing us to compare them.

Based on the result of the comparison, the corresponding output gate of the CONDITIONAL node will be activated. In this case, we have set the operator_type parameter to >, indicating that the comparison being performed is greater than.

As a result, the true output gate of the CONDITIONAL node will be triggered, leading to the execution of the Plotly Visual LINE node connected to it.