Skip to content

Commit

Permalink
Improved comments and removed unnecessary import
Browse files Browse the repository at this point in the history
  • Loading branch information
koniksedy authored and Adda0 committed Nov 22, 2024
1 parent ce0ae13 commit f9e1db5
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 23 deletions.
4 changes: 2 additions & 2 deletions include/mata/nft/algorithms.hh
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Simlib::Util::BinaryRelation compute_relation(
* @param[out] prod_map Can be used to get the mapping of the pairs of the original states to product states.
* Mostly useless, it is only filled in and returned if !=nullptr, but the algorithm internally uses another data structures,
* because this one is too slow.
* @param[in] lhs_first_aux_state The first auxiliary state in @p lhs. Two auxiliary states does not form a product state.
* @param[in] rhs_first_aux_state The first auxiliary state in @p rhs. Two auxiliary states does not form a product state.
* @param[in] lhs_first_aux_state The first auxiliary state in @p lhs. Two auxiliary states can not form a product state.
* @param[in] rhs_first_aux_state The first auxiliary state in @p rhs. Two auxiliary states con not form a product state.
* @return NFT as a product of NFTs @p lhs and @p rhs with ε handled as regular symbols.
*/
Nft product(const Nft& lhs, const Nft& rhs, const std::function<bool(State,State)> && final_condition,
Expand Down
40 changes: 20 additions & 20 deletions include/mata/nft/nft.hh
Original file line number Diff line number Diff line change
Expand Up @@ -499,10 +499,10 @@ Nft remove_epsilon(const Nft& aut, Symbol epsilon = EPSILON);
/**
* @brief Projects out specified levels @p levels_to_project in the given transducer @p nft.
*
* @param nft The transducer for projection.
* @param levels_to_project A non-empty ordered vector of levels to be projected out from the transducer. It must
* @param[in] nft The transducer for projection.
* @param[in] levels_to_project A non-empty ordered vector of levels to be projected out from the transducer. It must
* contain only values that are greater than or equal to 0 and smaller than @c levels_cnt.
* @param repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @p DONT_CARE symbols.
* @return A new projected transducer.
Expand All @@ -512,10 +512,10 @@ Nft project_out(const Nft& nft, const utils::OrdVector<Level>& levels_to_project
/**
* @brief Projects out specified level @p level_to_project in the given transducer @p nft.
*
* @param nft The transducer for projection.
* @param level_to_project A level that is going to be projected out from the transducer. It has to be greater than or
* @param[in] nft The transducer for projection.
* @param[in] level_to_project A level that is going to be projected out from the transducer. It has to be greater than or
* equal to 0 and smaller than @c levels_cnt.
* @param repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @c DONT_CARE symbols.
* @return A new projected transducer.
Expand All @@ -525,10 +525,10 @@ Nft project_out(const Nft& nft, Level level_to_project, bool repeat_jump_symbol
/**
* @brief Projects to specified levels @p levels_to_project in the given transducer @p nft.
*
* @param nft The transducer for projection.
* @param levels_to_project A non-empty ordered vector of levels the transducer is going to be projected to.
* @param[in] nft The transducer for projection.
* @param[in] levels_to_project A non-empty ordered vector of levels the transducer is going to be projected to.
* It must contain only values greater than or equal to 0 and smaller than @c levels_cnt.
* @param repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @c DONT_CARE symbols.
* @return A new projected transducer.
Expand All @@ -538,10 +538,10 @@ Nft project_to(const Nft& nft, const utils::OrdVector<Level>& levels_to_project,
/**
* @brief Projects to a specified level @p level_to_project in the given transducer @p nft.
*
* @param nft The transducer for projection.
* @param level_to_project A level the transducer is going to be projected to. It has to be greater than or equal to 0
* @param[in] nft The transducer for projection.
* @param[in] level_to_project A level the transducer is going to be projected to. It has to be greater than or equal to 0
* and smaller than @c levels_cnt.
* @param repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] repeat_jump_symbol Specifies if the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @c DONT_CARE symbols.
* @return A new projected transducer.
Expand All @@ -555,11 +555,11 @@ Nft project_to(const Nft& nft, Level level_to_project, bool repeat_jump_symbol =
* The vector @c new_levels_mask must be nonempty, its length must be greater than @c levels_cnt,
* and it must contain exactly @c levels_cnt occurrences of false.
*
* @param nft The original transducer.
* @param new_levels_mask A mask representing the old and new levels. The vector {1, 0, 1, 1, 0} indicates
* @param[in] nft The original transducer.
* @param[in] new_levels_mask A mask representing the old and new levels. The vector {1, 0, 1, 1, 0} indicates
* that one level is inserted before level 0 and two levels are inserted before level 1.
* @param default_symbol The default symbol to be used for transitions at the inserted levels.
* @param repeat_jump_symbol Specifies whether the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] default_symbol The default symbol to be used for transitions at the inserted levels.
* @param[in] repeat_jump_symbol Specifies whether the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @c DONT_CARE symbols.
*/
Expand All @@ -570,13 +570,13 @@ Nft insert_levels(const Nft& nft, const BoolVector& new_levels_mask, const Symbo
*
* @c levels_cnt must be greater than 0.
*
* @param nft The original transducer.
* @param new_level Specifies the new level to be inserted into the transducer.
* @param[in] nft The original transducer.
* @param[in] new_level Specifies the new level to be inserted into the transducer.
* If @p new_level is 0, then it is inserted before the 0-th level.
* If @p new_level is less than @c levels_cnt, then it is inserted before the level @c new_level-1.
* If @p new_level is greater than or equal to @c levels_cnt, then all levels from @c levels_cnt through @p new_level are appended after the last level.
* @param default_symbol The default symbol to be used for transitions at the inserted levels.
* @param repeat_jump_symbol Specifies whether the symbol on a jump transition (a transition with a length greater than 1)
* @param[in] default_symbol The default symbol to be used for transitions at the inserted levels.
* @param[in] repeat_jump_symbol Specifies whether the symbol on a jump transition (a transition with a length greater than 1)
* is interpreted as a sequence repeating the same symbol or as a single instance of the symbol followed by a sequence
* of @c DONT_CARE symbols.
*/
Expand Down
1 change: 0 additions & 1 deletion src/nft/composition.cc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
// MATA headers
#include "mata/nft/nft.hh"
#include <cassert>
#include <functional>


using namespace mata::utils;
Expand Down

0 comments on commit f9e1db5

Please sign in to comment.