Skip to content

Commit f1a8bbd

Browse files
committed
optimize: address review comments on ObjectiveFunction/CSEOptions doc
- ObjectiveFunction comment no longer references the removed `Memsize` name; describe what DenseFLOPs/DenseSize each count instead. - Drop the "`CSE` is an initialism" sentence (naming rationale belongs in the commit/PR, not the code comment).
1 parent 60ba27b commit f1a8bbd

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

SeQuant/core/optimize/options.hpp

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ class Index;
1010
class Tensor;
1111

1212
/// Objective function to minimize in single-term and top-level optimize
13-
/// routines. The `Dense*` models are the current cost estimates, which assume
14-
/// dense tensors; "Size" (not "Memsize") because operands need not live in
15-
/// memory (disk, distributed, ...). Leaves room for `Sparse*` models later.
13+
/// routines. The `Dense*` models assume dense tensors: `DenseFLOPs` counts
14+
/// floating-point operations, `DenseSize` counts result-tensor storage elements
15+
/// (summed over intermediates). Leaves room for `Sparse*` models later.
1616
enum class ObjectiveFunction { DenseFLOPs, DenseSize };
1717

1818
/// Whether to reorder summands so terms with shared intermediates appear
@@ -22,8 +22,7 @@ enum class ReorderSum { Reorder, NoReorder };
2222
/// Common-subexpression-elimination (CSE) options for single-term
2323
/// optimization. `subnet` recognizes equivalent subnetworks while searching for
2424
/// an evaluation order, trading extra search time for potentially lower op
25-
/// counts. (Room to grow, e.g. a maximum subnet size to consider.) `CSE` is an
26-
/// initialism.
25+
/// counts. (Room to grow, e.g. a maximum subnet size to consider.)
2726
struct CSEOptions {
2827
bool subnet = false;
2928
};

0 commit comments

Comments
 (0)