concepts.pdsketch.crow.crow_state.TotallyOrderedPlan

class TotallyOrderedPlan

Bases: object

A totally ordered plan sequence.

Methods

exclude(index)	Exclude the given index from the sequence; return a new sequence.
gen_string()	Generate the string representation of the plan.
get_return_all_skeletons_flag(index)	Get the return_all_skeletons flag of the given index.

Attributes

sequence	The sequence of the plan.
return_all_skeletons_flags	For each item in the sequence, whether to return all the skeletons.
is_ordered	Whether the sequence is ordered.

__init__(sequence, return_all_skeletons_flags=None, is_ordered=True)

Initialize the totally ordered plan sequence.

Parameters:

• sequence (Sequence[ValueOutputExpression | RegressionRuleApplier]) – the sequence of the plan.

• is_ordered (bool) – whether the sequence is ordered.

• return_all_skeletons_flags (Sequence[bool] | bool | None)

__len__()

__new__(**kwargs)

exclude(index)

Exclude the given index from the sequence; return a new sequence.

Parameters:

index (int)

gen_string()

Generate the string representation of the plan.

get_return_all_skeletons_flag(index)

Get the return_all_skeletons flag of the given index. If the flag is not set, then return True.

Parameters:

index (int)

Return type:

bool

is_ordered: bool

Whether the sequence is ordered. If it’s not ordered, then the sequence is treated as a set.

return_all_skeletons_flags: Tuple[bool, ...] | None

For each item in the sequence, whether to return all the skeletons. This value can be set to None when is_ordered is False.

sequence: Tuple[ValueOutputExpression | RegressionRuleApplier, ...]

The sequence of the plan.