Merge branch 'master' of https://github.com/verilog-to-routing/vtr-verilog-to-routing into remove_node

Author: amin1377

vpr/src/base/atom_lookup_fwd.h

@@ -3,6 +3,6 @@
 class AtomLookup;
 
 enum class BlockTnode {
-    INTERNAL, ///<tnodes corresponding to internal paths withing atom blocks
+    INTERNAL, ///<tnodes corresponding to internal paths within atom blocks
     EXTERNAL  ///<tnodes corresponding to external interface of atom blocks
 };

vpr/src/base/atom_netlist.h

@@ -127,7 +127,7 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
      */
 
     /**
-     * @brief Returns the AtomPortId of the specifed port if it exists or AtomPortId::INVALID() if not
+     * @brief Returns the AtomPortId of the specified port if it exists or AtomPortId::INVALID() if not
      * @note This method is typically more efficient than searching by name
      *
      *   @param blk_id The   ID of the block who's ports will be checked

vpr/src/base/atom_netlist_utils.cpp

@@ -20,10 +20,10 @@
  */
 int infer_and_mark_constant_pins(AtomNetlist& netlist, e_const_gen_inference const_gen_inference_method, const LogicalModels& models, int verbosity);
 
-///@brief Marks all primtive output pins which have no combinationally connected inputs as constant pins
+///@brief Marks all primitive output pins which have no combinationally connected inputs as constant pins
 int mark_undriven_primitive_outputs_as_constant(AtomNetlist& netlist, int verbosity);
 
-///@brief Marks all primtive output pins of blk which have only constant inputs as constant pins
+///@brief Marks all primitive output pins of blk which have only constant inputs as constant pins
 int infer_and_mark_block_pins_constant(AtomNetlist& netlist, AtomBlockId blk, e_const_gen_inference const_gen_inference_method, const LogicalModels& models, int verbosity);
 int infer_and_mark_block_combinational_outputs_constant(AtomNetlist& netlist, AtomBlockId blk, e_const_gen_inference const_gen_inference_method, int verbosity);
 int infer_and_mark_block_sequential_outputs_constant(AtomNetlist& netlist, AtomBlockId blk, e_const_gen_inference const_gen_inference_method, const LogicalModels& models, int verbosity);
@@ -129,7 +129,7 @@ void print_netlist_as_blif(FILE* f, const AtomNetlist& netlist, const LogicalMod
 
         //Artificial buffers
         for (auto buf_pair : artificial_buffer_connections_required) {
-            fprintf(f, "#Artificially inserted primary-output assigment buffer\n");
+            fprintf(f, "#Artificially inserted primary-output assignment buffer\n");
             fprintf(f, ".names %s %s\n", buf_pair.first.c_str(), buf_pair.second.c_str());
             fprintf(f, "1 1\n");
             fprintf(f, "\n");
@@ -194,7 +194,7 @@ void print_netlist_as_blif(FILE* f, const AtomNetlist& netlist, const LogicalMod
             auto type = "re";
 
             //Latch initial value
-            int init_val = 3; //Unkown or unspecified
+            int init_val = 3; //Unknown or unspecified
             //The initial value is stored as a single value in the truth table
             const auto& so_cover = netlist.block_truth_table(blk_id);
             if (so_cover.size() == 1) {
@@ -849,7 +849,7 @@ bool remove_buffer_lut(AtomNetlist& netlist, AtomBlockId blk, const LogicalModel
     //We now need to determine the name of the 'new' net
     //
     // We need to be careful about this name since a net pin could be
-    // a Primary-Input/Primary-Output, and we don't want to change PI/PO names (for equivalance checking)
+    // a Primary-Input/Primary-Output, and we don't want to change PI/PO names (for equivalence checking)
     //
     //Check if we have any PI/POs in the new net's pins
     // Note that the driver can only (potentially) be an INPAD, and the sinks only (potentially) OUTPADs
@@ -873,10 +873,10 @@ bool remove_buffer_lut(AtomNetlist& netlist, AtomBlockId blk, const LogicalModel
     auto output_net_name = netlist.net_name(output_net);
 
     if ((driver_is_pi || po_in_input_sinks) && !po_in_output_sinks) {
-        //Must use the input name to perserve primary-input or primary-output name
+        //Must use the input name to preserve primary-input or primary-output name
         new_net_name = input_net_name;
     } else if (!(driver_is_pi || po_in_input_sinks) && po_in_output_sinks) {
-        //Must use the output name to perserve primary-output name
+        //Must use the output name to preserve primary-output name
         new_net_name = output_net_name;
     } else {
         new_net_name = input_net_name;
@@ -1077,7 +1077,7 @@ size_t sweep_blocks(AtomNetlist& netlist, const LogicalModels& models, int verbo
 
         AtomBlockType type = netlist.block_type(blk_id);
 
-        //Don't remove inpads/outpads here, we have seperate sweep functions for these
+        //Don't remove inpads/outpads here, we have separate sweep functions for these
         if (type == AtomBlockType::INPAD || type == AtomBlockType::OUTPAD) continue;
 
         //We remove any blocks with no fanout

vpr/src/base/atom_netlist_utils.h

@@ -59,7 +59,7 @@ size_t sweep_constant_primary_outputs(AtomNetlist& netlist, int verbosity);
  */
 
 /**
- * @brief Deterimine whether a truth table encodes the logic functions 'On' set (returns true)
+ * @brief Determine whether a truth table encodes the logic functions 'On' set (returns true)
  *        or 'Off' set (returns false)
  */
 bool truth_table_encodes_on_set(const AtomNetlist::TruthTable& truth_table);
@@ -79,16 +79,16 @@ AtomNetlist::TruthTable expand_truth_table(const AtomNetlist::TruthTable& truth_
  *
  *   @param truth_table   The truth table to expand
  *   @param num_inputs    The number of inputs to use
- *   @param permutation   A vector indicies to permute, permutation[i] is the input pin where
+ *   @param permutation   A vector indices to permute, permutation[i] is the input pin where
  *                        the signal currently connected to input i should be placed
  */
 AtomNetlist::TruthTable permute_truth_table(const AtomNetlist::TruthTable& truth_table, const size_t num_inputs, const std::vector<int>& permutation);
 
-///@brief Convers a truth table to a lut mask (sequence of binary values representing minterms)
+///@brief Converts a truth table to a lut mask (sequence of binary values representing minterms)
 std::vector<vtr::LogicValue> truth_table_to_lut_mask(const AtomNetlist::TruthTable& truth_table, const size_t num_inputs);
 
 /**
- * @brief Convers a logic cube (potnetially including don't cares) into
+ * @brief Converts a logic cube (potnetially including don't cares) into
  *        a sequence of minterm numbers
  */
 std::vector<size_t> cube_to_minterms(std::vector<vtr::LogicValue> cube);

vpr/src/base/clustered_netlist.h

@@ -223,7 +223,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
      */
 
     /**
-     * @brief The intented use is to find the block id of a 
+     * @brief The intended use is to find the block id of a 
      *        hard block without knowing its name in the netlist. Instead
      *        a pattern can be created that we know the block's name will
      *        match to. Generally, we expect the pattern to be constructed
@@ -238,8 +238,8 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
      *        function can be used by just providing the string pattern as
      *        ".*test_ram.*". We know that the module name should be somewhere
      *        within the string, so the pattern we provide says that the netlist
-     *        name of the block contains arbritary characters then the module
-     *        name and then some other arbritary characters after.
+     *        name of the block contains arbitrary characters then the module
+     *        name and then some other arbitrary characters after.
      *        This pattern will then be used to match to the block in the
      *        netlist. The matched cluster block id is returned, and if no
      *        block matched to the input string then an invalid block id

vpr/src/base/flat_placement_types.h

@@ -77,7 +77,7 @@ class FlatPlacementInfo {
     // the flat placement to encode information about where atom blocks would
     // want to go if they cannot be placed at the grid position they are at.
     // (for example, a block placed at (0.9, 0.9) wants to be at tile (0, 0),
-    // but if thats not possible it would prefer (1, 1) over anything else.
+    // but if that's not possible it would prefer (1, 1) over anything else.
 
     /// @brief The x-positions of each atom block. Is UNDEFINED_POS if undefined.
     vtr::vector<AtomBlockId, float> blk_x_pos;

vpr/src/base/gen/README.gen.md

@@ -1,3 +1,3 @@
 `vpr_constraints_uxsdcxx.h`and
 `vpr_constraints_uxsdcxx_interface.h` are generated via uxsdcxx and are checked in to
-avoid requiring python3 and the uxsdcxx depedencies to build VPR.
+avoid requiring python3 and the uxsdcxx dependencies to build VPR.

vpr/src/base/netlist.h

@@ -633,7 +633,7 @@ class Netlist {
     /**
      * @brief Removes a pin from the netlist.
      *
-     * The pin is marked invalid, and removed from any assoicated nets
+     * The pin is marked invalid, and removed from any associated nets
      *   @param pin_id   The pin_id of the pin to be removed
      */
     void remove_pin(const PinId pin_id);
@@ -680,7 +680,7 @@ class Netlist {
     void remove_net(const NetId net_id);
 
     /**
-     * @brief Removes a connection betwen a net and pin.
+     * @brief Removes a connection between a net and pin.
      *
      * The pin is removed from the net and the pin
      * will be marked as having no associated net
@@ -730,7 +730,7 @@ class Netlist {
     /**
      * @brief Finds a block where the block's name contains the
      *        provided input name as a substring. 
-     *        The intented use is to find the block id of a 
+     *        The intended use is to find the block id of a 
      *        hard block without knowing its name in the netlist. Instead
      *        the block's module name in the HDL design can be used as it will
      *        be a substring within its full name in the netlist.
@@ -754,7 +754,7 @@ class Netlist {
      *              The clustered netlist class defines another version of this
      *              function that find blocks by checking for a pattern match,
      *              meaning that the input is a pattern string and the pattern
-     *              is looked for ine each block name.
+     *              is looked for in each block name.
      * 
      * @param name_substring A substring of a block name for which an ID needs  
      *             to be found.
@@ -765,7 +765,7 @@ class Netlist {
     BlockId find_block_by_name_fragment(const std::string& name_substring) const;
 
     /**
-     * @brief Returns the PortId of the specifed port if it exists or PortId::INVALID() if not
+     * @brief Returns the PortId of the specified port if it exists or PortId::INVALID() if not
      *
      * @note  This method is typically less efficient than searching by a t_model_port
      *        With the overloaded AtomNetlist method
@@ -948,21 +948,21 @@ class Netlist {
      */
 
     /**
-     * @brief Returns the StringId of the specifed string if it exists or StringId::INVALID() if not
+     * @brief Returns the StringId of the specified string if it exists or StringId::INVALID() if not
      *
      *   @param str   The string to look for
      */
     StringId find_string(const std::string& str) const;
 
     /**
-     * @brief Returns the BlockId of the specifed block if it exists or BlockId::INVALID() if not
+     * @brief Returns the BlockId of the specified block if it exists or BlockId::INVALID() if not
      *
      *   @param name_id : The block name to look for
      */
     BlockId find_block(const StringId name_id) const;
 
     /**
-     * @brief Returns the NetId of the specifed port if it exists or NetId::INVALID() if not
+     * @brief Returns the NetId of the specified port if it exists or NetId::INVALID() if not
      *
      *   @param name_id   The string ID of the net name to look for
      */

vpr/src/base/netlist.tpp

@@ -532,7 +532,7 @@ PinId Netlist<BlockId, PortId, PinId, NetId>::find_pin(const PortId port_id, Bit
 
     if (iter == pins_rng.end() || pin_port_bit(*iter) != port_bit) {
         //Either the end of the pins (i.e. not found), or
-        //the value does not match (indicating a gap in the indicies, so also not found)
+        //the value does not match (indicating a gap in the indices, so also not found)
         return PinId::INVALID();
     } else {
         //Found it
@@ -1325,7 +1325,7 @@ void Netlist<BlockId, PortId, PinId, NetId>::rebuild_block_refs(const vtr::vecto
         VTR_ASSERT_SAFE_MSG(all_valid(pin_collection), "All Ids should be valid");
         VTR_ASSERT(pin_collection.size() == size_t(block_num_input_pins_[blk_id] + block_num_output_pins_[blk_id] + block_num_clock_pins_[blk_id]));
 
-        //Similarily for ports
+        //Similarly for ports
         size_t num_input_ports = count_valid_refs(block_input_ports(blk_id), port_id_map);
         size_t num_output_ports = count_valid_refs(block_output_ports(blk_id), port_id_map);
         size_t num_clock_ports = count_valid_refs(block_clock_ports(blk_id), port_id_map);
@@ -1710,12 +1710,12 @@ bool Netlist<BlockId, PortId, PinId, NetId>::validate_port_pin_refs() const {
 
             //Verify that the pins are listed in increasing order of port bit index,
             //we rely on this property to perform fast binary searches for pins with specific bit
-            //indicies
+            //indices
             if (first_bit) {
                 prev_bit_index = port_bit_index;
                 first_bit = false;
             } else if (prev_bit_index >= port_bit_index) {
-                VPR_FATAL_ERROR(VPR_ERROR_NETLIST, "Port pin indicies are not in ascending order");
+                VPR_FATAL_ERROR(VPR_ERROR_NETLIST, "Port pin indices are not in ascending order");
             }
         }
     }
@@ -1909,7 +1909,7 @@ BlockId Netlist<BlockId, PortId, PinId, NetId>::find_block(const typename Netlis
 
 template<typename BlockId, typename PortId, typename PinId, typename NetId>
 void Netlist<BlockId, PortId, PinId, NetId>::associate_pin_with_block(const PinId pin_id, const PortType type, const BlockId blk_id) {
-    //Get an interator pointing to where we want to insert
+    //Get an iterator pointing to where we want to insert
     pin_iterator iter;
     if (type == PortType::INPUT) {
         iter = block_input_pins(blk_id).end();
@@ -1981,7 +1981,7 @@ template<typename BlockId, typename PortId, typename PinId, typename NetId>
 void Netlist<BlockId, PortId, PinId, NetId>::associate_port_with_block(const PortId port_id, const PortType type, const BlockId blk_id) {
     //Associate the port with the blocks inputs/outputs/clocks
 
-    //Get an interator pointing to where we want to insert
+    //Get an iterator pointing to where we want to insert
     port_iterator iter;
     if (type == PortType::INPUT) {
         iter = block_input_ports(blk_id).end();

vpr/src/base/netlist_utils.h

@@ -56,7 +56,7 @@ vtr::vector_map<Id, Id> compress_ids(const vtr::vector_map<Id, Id>& ids) {
  * @brief Returns a vector based on 'values', which has had entries
  *        dropped & re-ordered according according to 'id_map'.
  *
- * Each entry in id_map corresponds to the assoicated element in 'values'.
+ * Each entry in id_map corresponds to the associated element in 'values'.
  * The value of the id_map entry is the new ID of the entry in values.
  *
  * If it is an invalid ID, the element in values is dropped.