Skip to content

ARROW-11692: [Rust][DataFusion] Improve OptimizerRule comments #9529

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

Closed
alamb wants to merge 3 commits into from
Closed

ARROW-11692: [Rust][DataFusion] Improve OptimizerRule comments #9529

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9a6a12
ARROW-11692: [Rust][DataFusion] Improve OptimizerRule comments
alamb Feb 18, 2021
09b3027
Correct signature
alamb Feb 18, 2021
8035d9b
cargo fmt
alamb Feb 19, 2021
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
10 changes: 6 additions & 4 deletions rust/datafusion/src/optimizer/optimizer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@
use crate::error::Result;
use crate::logical_plan::LogicalPlan;

/// An optimizer rules performs a transformation on a logical plan to produce an optimized
/// logical plan.
/// `OptimizerRule` transforms one ['LogicalPlan'] into another which
/// computes the same results, but in a potentially more efficient
/// way.
pub trait OptimizerRule {
/// Perform optimizations on the plan
/// Rewrite `plan` to an optimized form
fn optimize(&self, plan: &LogicalPlan) -> Result<LogicalPlan>;
/// Produce a human readable name for this optimizer rule

/// A human readable name for this optimizer rule
fn name(&self) -> &str;
}