metagraphoptimization.jl/src/operation/utility.jl

"""
    isempty(operations::PossibleOperations)

Return whether `operations` is empty, i.e. all of its fields are empty.
"""
function isempty(operations::PossibleOperations)
    return isempty(operations.nodeFusions) &&
           isempty(operations.nodeReductions) &&
           isempty(operations.nodeSplits)
end

"""
    length(operations::PossibleOperations)

Return a named tuple with the number of each of the operation types as a named tuple. The fields are named the same as the [`PossibleOperations`](@ref)'.
"""
function length(operations::PossibleOperations)
    return (
        nodeFusions = length(operations.nodeFusions),
        nodeReductions = length(operations.nodeReductions),
        nodeSplits = length(operations.nodeSplits),
    )
end

"""
    delete!(operations::PossibleOperations, op::NodeFusion)

Delete the given node fusion from the possible operations.
"""
function delete!(operations::PossibleOperations, op::NodeFusion)
    delete!(operations.nodeFusions, op)
    return operations
end

"""
    delete!(operations::PossibleOperations, op::NodeReduction)

Delete the given node reduction from the possible operations.
"""
function delete!(operations::PossibleOperations, op::NodeReduction)
    delete!(operations.nodeReductions, op)
    return operations
end

"""
    delete!(operations::PossibleOperations, op::NodeSplit)

Delete the given node split from the possible operations.
"""
function delete!(operations::PossibleOperations, op::NodeSplit)
    delete!(operations.nodeSplits, op)
    return operations
end

"""
    can_fuse(n1::ComputeTaskNode, n2::DataTaskNode, n3::ComputeTaskNode)

Return whether the given nodes can be fused. See [`NodeFusion`](@ref) for the requirements.
"""
function can_fuse(n1::ComputeTaskNode, n2::DataTaskNode, n3::ComputeTaskNode)
    if !is_child(n1, n2) || !is_child(n2, n3)
        # the checks are redundant but maybe a good sanity check
        return false
    end

    if length(n2.parents) != 1 ||
       length(n2.children) != 1 ||
       length(n1.parents) != 1
        return false
    end

    return true
end

"""
    can_reduce(n1::Node, n2::Node)

Return whether the given two nodes can be reduced. See [`NodeReduction`](@ref) for the requirements.
"""
function can_reduce(n1::Node, n2::Node)
    if (n1.task != n2.task)
        return false
    end

    n1_length = length(n1.children)
    n2_length = length(n2.children)

    if (n1_length != n2_length)
        return false
    end

    # this seems to be the most common case so do this first
    # doing it manually is a lot faster than using the sets for a general solution
    if (n1_length == 2)
        if (n1.children[1] != n2.children[1])
            if (n1.children[1] != n2.children[2])
                return false
            end
            # 1_1 == 2_2
            if (n1.children[2] != n2.children[1])
                return false
            end
            return true
        end

        # 1_1 == 2_1
        if (n1.children[2] != n2.children[2])
            return false
        end
        return true
    end

    # this is simple
    if (n1_length == 1)
        return n1.children[1] == n2.children[1]
    end

    # this takes a long time
    return Set(n1.children) == Set(n2.children)
end

"""
    can_split(n1::Node)

Return whether the given node can be split. See [`NodeSplit`](@ref) for the requirements.
"""
function can_split(n::Node)
    return length(parents(n)) > 1
end

"""
    ==(op1::Operation, op2::Operation)

Fallback implementation of operation equality. Return false. Actual comparisons are done by the overloads of same type operation comparisons.
"""
function ==(op1::Operation, op2::Operation)
    return false
end

"""
    ==(op1::NodeFusion, op2::NodeFusion)

Equality comparison between two node fusions. Two node fusions are considered equal if they have the same inputs.
"""
function ==(op1::NodeFusion, op2::NodeFusion)
    # there can only be one node fusion on a given data task, so if the data task is the same, the fusion is the same
    return op1.input[2] == op2.input[2]
end

"""
    ==(op1::NodeReduction, op2::NodeReduction)

Equality comparison between two node reductions. Two node reductions are considered equal when they have the same inputs.
"""
function ==(op1::NodeReduction, op2::NodeReduction)
    # node reductions are equal exactly if their first input is the same
    return op1.input[1].id == op2.input[1].id
end

"""
    ==(op1::NodeSplit, op2::NodeSplit)

Equality comparison between two node splits. Two node splits are considered equal if they have the same input node.
"""
function ==(op1::NodeSplit, op2::NodeSplit)
    return op1.input == op2.input
end