Skip to content

Encapsulate fields of EquivalenceProperties #14040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Encapsulate fields of EquivalenceProperties #14040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion datafusion/core/src/physical_optimizer/sanity_checker.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ pub fn check_plan_sanity(
plan_str,
format_physical_sort_requirement_list(&sort_req),
idx,
child_eq_props.oeq_class
child_eq_props.oeq_class()
);
}
}
Expand Down
8 changes: 4 additions & 4 deletions datafusion/core/tests/fuzz_cases/equivalence/ordering.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ fn test_ordering_satisfy_with_equivalence_random() -> Result<()> {
table_data_with_properties.clone(),
)?;
let err_msg = format!(
"Error in test case requirement:{:?}, expected: {:?}, eq_properties.oeq_class: {:?}, eq_properties.eq_group: {:?}, eq_properties.constants: {:?}",
requirement, expected, eq_properties.oeq_class, eq_properties.eq_group, eq_properties.constants
"Error in test case requirement:{:?}, expected: {:?}, eq_properties {}",
requirement, expected, eq_properties
);
// Check whether ordering_satisfy API result and
// experimental result matches.
Expand Down Expand Up @@ -141,8 +141,8 @@ fn test_ordering_satisfy_with_equivalence_complex_random() -> Result<()> {
table_data_with_properties.clone(),
)?;
let err_msg = format!(
"Error in test case requirement:{:?}, expected: {:?}, eq_properties.oeq_class: {:?}, eq_properties.eq_group: {:?}, eq_properties.constants: {:?}",
requirement, expected, eq_properties.oeq_class, eq_properties.eq_group, eq_properties.constants
"Error in test case requirement:{:?}, expected: {:?}, eq_properties: {}",
requirement, expected, eq_properties,
);
// Check whether ordering_satisfy API result and
// experimental result matches.
Expand Down
8 changes: 4 additions & 4 deletions datafusion/core/tests/fuzz_cases/equivalence/projection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ fn project_orderings_random() -> Result<()> {
// Make sure each ordering after projection is valid.
for ordering in projected_eq.oeq_class().iter() {
let err_msg = format!(
"Error in test case ordering:{:?}, eq_properties.oeq_class: {:?}, eq_properties.eq_group: {:?}, eq_properties.constants: {:?}, proj_exprs: {:?}",
ordering, eq_properties.oeq_class, eq_properties.eq_group, eq_properties.constants, proj_exprs
"Error in test case ordering:{:?}, eq_properties {}, proj_exprs: {:?}",
ordering, eq_properties, proj_exprs,
);
// Since ordered section satisfies schema, we expect
// that result will be same after sort (e.g sort was unnecessary).
Expand Down Expand Up @@ -179,8 +179,8 @@ fn ordering_satisfy_after_projection_random() -> Result<()> {
projected_batch.clone(),
)?;
let err_msg = format!(
"Error in test case requirement:{:?}, expected: {:?}, eq_properties.oeq_class: {:?}, eq_properties.eq_group: {:?}, eq_properties.constants: {:?}, projected_eq.oeq_class: {:?}, projected_eq.eq_group: {:?}, projected_eq.constants: {:?}, projection_mapping: {:?}",
requirement, expected, eq_properties.oeq_class, eq_properties.eq_group, eq_properties.constants, projected_eq.oeq_class, projected_eq.eq_group, projected_eq.constants, projection_mapping
"Error in test case requirement:{:?}, expected: {:?}, eq_properties: {}, projected_eq: {}, projection_mapping: {:?}",
requirement, expected, eq_properties, projected_eq, projection_mapping
);
// Check whether ordering_satisfy API result and
// experimental result matches.
Expand Down
4 changes: 2 additions & 2 deletions datafusion/core/tests/fuzz_cases/equivalence/properties.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ fn test_find_longest_permutation_random() -> Result<()> {
);

let err_msg = format!(
"Error in test case ordering:{:?}, eq_properties.oeq_class: {:?}, eq_properties.eq_group: {:?}, eq_properties.constants: {:?}",
ordering, eq_properties.oeq_class, eq_properties.eq_group, eq_properties.constants
"Error in test case ordering:{:?}, eq_properties: {}",
ordering, eq_properties
);
assert_eq!(ordering.len(), indices.len(), "{}", err_msg);
// Since ordered section satisfies schema, we expect
Expand Down
6 changes: 3 additions & 3 deletions datafusion/core/tests/fuzz_cases/equivalence/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ pub fn generate_table_for_eq_properties(
};

// Fill constant columns
for constant in &eq_properties.constants {
for constant in eq_properties.constants() {
let col = constant.expr().as_any().downcast_ref::<Column>().unwrap();
let (idx, _field) = schema.column_with_name(col.name()).unwrap();
let arr =
Expand All @@ -382,7 +382,7 @@ pub fn generate_table_for_eq_properties(
}

// Fill columns based on ordering equivalences
for ordering in eq_properties.oeq_class.iter() {
for ordering in eq_properties.oeq_class().iter() {
let (sort_columns, indices): (Vec<_>, Vec<_>) = ordering
.iter()
.map(|PhysicalSortExpr { expr, options }| {
Expand All @@ -406,7 +406,7 @@ pub fn generate_table_for_eq_properties(
}

// Fill columns based on equivalence groups
for eq_group in eq_properties.eq_group.iter() {
for eq_group in eq_properties.eq_group().iter() {
let representative_array =
get_representative_arr(eq_group, &schema_vec, Arc::clone(schema))
.unwrap_or_else(|| generate_random_array(n_elem, n_distinct));
Expand Down
14 changes: 8 additions & 6 deletions datafusion/physical-expr/src/equivalence/ordering.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,15 +291,17 @@ mod tests {
},
]);
// finer ordering satisfies, crude ordering should return true
let mut eq_properties_finer =
EquivalenceProperties::new(Arc::clone(&input_schema));
eq_properties_finer.oeq_class.push(finer.clone());
let eq_properties_finer = EquivalenceProperties::new_with_orderings(
Arc::clone(&input_schema),
&[finer.clone()],
);
assert!(eq_properties_finer.ordering_satisfy(crude.as_ref()));

// Crude ordering doesn't satisfy finer ordering. should return false
let mut eq_properties_crude =
EquivalenceProperties::new(Arc::clone(&input_schema));
eq_properties_crude.oeq_class.push(crude);
let eq_properties_crude = EquivalenceProperties::new_with_orderings(
Arc::clone(&input_schema),
&[crude.clone()],
);
assert!(!eq_properties_crude.ordering_satisfy(finer.as_ref()));
Ok(())
}
Expand Down
14 changes: 7 additions & 7 deletions datafusion/physical-expr/src/equivalence/properties.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,15 +124,15 @@ use itertools::Itertools;
/// ```
#[derive(Debug, Clone)]
pub struct EquivalenceProperties {
/// Collection of equivalence classes that store expressions with the same
/// value.
pub eq_group: EquivalenceGroup,
/// Equivalent sort expressions for this table.
pub oeq_class: OrderingEquivalenceClass,
/// Expressions whose values are constant throughout the table.
/// Distinct equivalence classes (exprs known to have the same expressions)
eq_group: EquivalenceGroup,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here are the changes. I want to make sure that nothing externally can modify these fields without going through methods on EquivalenceProperties

/// Equivalent sort expressions
oeq_class: OrderingEquivalenceClass,
/// Expressions whose values are constant
///
/// TODO: We do not need to track constants separately, they can be tracked
/// inside `eq_groups` as `Literal` expressions.
pub constants: Vec<ConstExpr>,
constants: Vec<ConstExpr>,
/// Schema associated with this object.
schema: SchemaRef,
}
Expand Down
4 changes: 3 additions & 1 deletion datafusion/physical-plan/src/memory.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,9 @@ impl MemoryExec {
ProjectionMapping::try_new(&proj_exprs, &self.original_schema())?;
sort_information = base_eqp
.project(&projection_mapping, self.schema())
.oeq_class
.oeq_class()
// TODO add a take / into to avoid the clone
.clone()
.orderings;
}

Expand Down
4 changes: 2 additions & 2 deletions datafusion/physical-plan/src/union.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,9 +843,9 @@ mod tests {
) {
// Check whether orderings are same.
let lhs_orderings = lhs.oeq_class();
let rhs_orderings = &rhs.oeq_class.orderings;
let rhs_orderings = rhs.oeq_class();
assert_eq!(lhs_orderings.len(), rhs_orderings.len(), "{}", err_msg);
for rhs_ordering in rhs_orderings {
for rhs_ordering in rhs_orderings.iter() {
assert!(lhs_orderings.contains(rhs_ordering), "{}", err_msg);
}
}
Expand Down
Loading