Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leissa committed Oct 15, 2024
1 parent 25ea6e0 commit 158e6aa
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion include/mim/axiom.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Axiom : public Def {
/// For a curried App of an Axiom, you only want to trigger normalization at specific spots.
/// For this reason, MimIR maintains a Def::curry_ counter that each App decrements.
/// The Axiom::normalizer() will be triggered when Axiom::curry() becomes `0`.
/// These are also the spots that you can mim::match/mim::force/Match.
/// These are also the spots that you can mim::match / mim::force / mim::Match.
/// After that, the counter will be set to Axiom::trip().
/// E.g., let's say an Axiom has this type:
/// ```
Expand Down
4 changes: 2 additions & 2 deletions include/mim/def.h
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,8 @@ class Def : public fe::RuntimeCast<Def> {
///@}

/// @name Free Vars and Muts
/// * local_muts()/local_vars() are Var%s/mutables reachable by following *immutable* extended_ops().
/// * local_muts()/local_vars() are cached and hash-consed.
/// * local_muts() / local_vars() are Var%s/mutables reachable by following *immutable* extended_ops().
/// * local_muts() / local_vars() are cached and hash-consed.
/// * free_vars() compute a global solution, i.e., by transitively following *mutables* as well.
/// * free_vars() are computed on demand and cached.
/// They will be transitively invalidated by following fv_consumers(), if a mutable is mutated.
Expand Down
6 changes: 3 additions & 3 deletions include/mim/tuple.h
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,12 @@ std::string tuple2str(const Def*);

/// Flattens a sigma/array/pack/tuple.
const Def* flatten(const Def* def);
/// Same as unflatten, but uses the operands of a flattened pack/tuple directly.
/// Same as unflatten, but uses the operands of a flattened Pack / Tuple directly.
size_t flatten(DefVec& ops, const Def* def, bool flatten_sigmas = true);

/// Applies the reverse transformation on a pack/tuple, given the original type.
/// Applies the reverse transformation on a Pack / Tuple, given the original type.
const Def* unflatten(const Def* def, const Def* type);
/// Same as unflatten, but uses the operands of a flattened pack/tuple directly.
/// Same as unflatten, but uses the operands of a flattened Pack / Tuple directly.
const Def* unflatten(Defs ops, const Def* type, bool flatten_muts = true);

DefVec merge(Defs, Defs);
Expand Down
2 changes: 0 additions & 2 deletions src/mim/phase/phase.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
#include "mim/phase/phase.h"

#include <vector>

namespace mim {

void Phase::run() {
Expand Down

0 comments on commit 158e6aa

Please sign in to comment.