Skip to content

Commit ce9e5d7

Browse files
authored
nit: AnalysisExpr docs are not quite true (#3479)
It is not and if-and-only-if, the implication only goes one way.
1 parent 3969680 commit ce9e5d7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

vortex-expr/src/analysis.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ pub trait StatsCatalog {
1313
/// This can be used by expression to plug into vortex expression analysis, such as
1414
/// pruning or expression simplification
1515
pub trait AnalysisExpr {
16-
/// Tries to find an expression over zone-statistics which is true if-and-only-if `expr` is
17-
/// false for all records in the zone.
16+
/// An expression over zone-statistics which implies all records in the zone evaluate to false.
17+
///
18+
/// Given an expression, `e`, if `e.stat_falsification(..)` evaluates to true, it is guaranteed
19+
/// that `e` evaluates to false on all records in the zone. However, the inverse is not
20+
/// necessarily true: even if the falsification evaluates to false, `e` need not evaluate to
21+
/// true on all records.
1822
///
1923
/// The `StatsCatalog` can be used to constrain or rename stats used in the final expr.
2024
///

0 commit comments

Comments
 (0)