From 1ce11412cb8b958b3a4d3e0164d0f3923d8ba0d7 Mon Sep 17 00:00:00 2001 From: AlexandreSinger Date: Fri, 21 Nov 2025 09:09:05 -0500 Subject: [PATCH] [Spelling] Fixed Spelling in the Libs Directory Fixed most of the spelling mistakes in the `libs` directory. There are a few which may require more work to fix, which I am leaving for the future where a more clean PR can be made. --- libs/libarchfpga/arch/mult_luts_arch.xml | 2 +- libs/libarchfpga/arch/sample_arch.xml | 4 ++-- libs/libarchfpga/src/arch_check.h | 2 +- libs/libarchfpga/src/arch_util.cpp | 2 +- libs/libarchfpga/src/echo_arch.cpp | 6 ++--- libs/libarchfpga/src/logic_types.h | 2 +- libs/libarchfpga/src/physical_types.h | 12 +++++----- libs/libarchfpga/src/physical_types_util.cpp | 2 +- .../src/read_fpga_interchange_arch.cpp | 2 +- libs/libarchfpga/src/read_xml_arch_file.cpp | 12 +++++----- .../src/read_xml_arch_file_interposer.h | 2 +- .../src/read_xml_arch_file_noc_tag.cpp | 14 +++++------ .../libarchfpga/src/read_xml_arch_file_sg.cpp | 4 ++-- libs/libarchfpga/src/read_xml_arch_file_sg.h | 2 +- libs/libarchfpga/src/vib_inf.h | 4 ++-- libs/libpugiutil/src/pugixml_loc.hpp | 2 +- libs/libpugiutil/src/pugixml_util.cpp | 2 +- libs/libpugiutil/src/pugixml_util.hpp | 8 +++---- libs/librrgraph/src/base/SCHEMA_GENERATOR.md | 4 ++-- libs/librrgraph/src/base/check_rr_graph.cpp | 4 ++-- libs/librrgraph/src/base/rr_graph_builder.h | 6 ++--- libs/librrgraph/src/base/rr_graph_obj.cpp | 8 +++---- libs/librrgraph/src/base/rr_graph_obj.h | 12 +++++----- libs/librrgraph/src/base/rr_graph_obj_utils.h | 2 +- libs/librrgraph/src/base/rr_graph_storage.h | 20 ++++++++-------- libs/librrgraph/src/base/rr_graph_view.h | 2 +- libs/librrgraph/src/base/rr_node.h | 4 ++-- libs/librrgraph/src/base/rr_node_impl.h | 2 +- libs/librrgraph/src/base/rr_rc_data.h | 2 +- libs/librrgraph/src/base/rr_spatial_lookup.h | 2 +- libs/librrgraph/src/io/gen/README.gen.md | 2 +- libs/librrgraph/src/io/rr_graph.xsd | 2 +- .../utils/alloc_and_load_rr_indexed_data.cpp | 2 +- libs/librtlnumber/Makefile | 2 +- libs/librtlnumber/README.md | 2 +- libs/librtlnumber/main.cpp | 2 +- .../basic_regression_tests.csv | 2 +- .../src/include/internal_bits.hpp | 14 +++++------ libs/librtlnumber/src/include/rtl_int.hpp | 2 +- libs/librtlnumber/src/include/rtl_utils.hpp | 2 +- libs/librtlnumber/src/rtl_int.cpp | 2 +- libs/librtlnumber/src/rtl_utils.cpp | 2 +- libs/librtlnumber/unit_test/Makefile | 2 +- libs/librtlnumber/unit_test/verilog_bits.cpp | 2 +- libs/librtlnumber/verify_librtlnumber.sh | 4 ++-- libs/libvqm/vqm_common.c | 24 +++++++++---------- libs/libvqm/vqm_dll.h | 6 ++--- libs/libvqm/vqm_parser.y | 4 ++-- libs/libvtrcapnproto/CMakeLists.txt | 2 +- libs/libvtrcapnproto/README.md | 4 ++-- libs/libvtrcapnproto/gen/README.gen.md | 2 +- libs/libvtrcapnproto/serdes_utils.h | 2 +- .../modules/GetGitRevisionDescription.cmake | 2 +- libs/libvtrutil/src/vtr_array_view.h | 6 ++--- libs/libvtrutil/src/vtr_error.h | 2 +- libs/libvtrutil/src/vtr_expr_eval.cpp | 2 +- libs/libvtrutil/src/vtr_expr_eval.h | 4 ++-- libs/libvtrutil/src/vtr_flat_map.h | 4 ++-- libs/libvtrutil/src/vtr_geometry.h | 4 ++-- libs/libvtrutil/src/vtr_linear_map.h | 4 ++-- libs/libvtrutil/src/vtr_math.h | 4 ++-- libs/libvtrutil/src/vtr_ndmatrix.h | 8 +++---- libs/libvtrutil/src/vtr_ndoffsetmatrix.h | 4 ++-- libs/libvtrutil/src/vtr_pair_util.h | 4 ++-- libs/libvtrutil/src/vtr_ragged_matrix.h | 2 +- libs/libvtrutil/src/vtr_range.h | 4 ++-- libs/libvtrutil/src/vtr_sentinels.h | 4 ++-- libs/libvtrutil/src/vtr_small_vector.h | 12 +++++----- libs/libvtrutil/src/vtr_string_interning.h | 8 +++---- libs/libvtrutil/src/vtr_strong_id.h | 2 +- libs/libvtrutil/src/vtr_strong_id_range.h | 6 ++--- libs/libvtrutil/src/vtr_token.h | 2 +- libs/libvtrutil/src/vtr_util.h | 12 +++++----- libs/libvtrutil/src/vtr_vec_id_set.h | 2 +- libs/libvtrutil/src/vtr_vector.h | 6 ++--- libs/libvtrutil/src/vtr_vector_map.h | 2 +- libs/libvtrutil/src/vtr_version.cpp.in | 2 +- libs/libvtrutil/test/test_small_vector.cpp | 2 +- 78 files changed, 177 insertions(+), 177 deletions(-) diff --git a/libs/libarchfpga/arch/mult_luts_arch.xml b/libs/libarchfpga/arch/mult_luts_arch.xml index 9941d3a796c..2375685ab74 100644 --- a/libs/libarchfpga/arch/mult_luts_arch.xml +++ b/libs/libarchfpga/arch/mult_luts_arch.xml @@ -140,7 +140,7 @@ - + diff --git a/libs/libarchfpga/arch/sample_arch.xml b/libs/libarchfpga/arch/sample_arch.xml index f2f3e7173b3..a119eaf4831 100755 --- a/libs/libarchfpga/arch/sample_arch.xml +++ b/libs/libarchfpga/arch/sample_arch.xml @@ -51,7 +51,7 @@ & delay of the Stratix IV crossbar as a good approximation of our crossbar. For LUTs, we include LUT - delays measured from Stratix IV which is dependant on the input used (ie. some + delays measured from Stratix IV which is dependent on the input used (ie. some LUT inputs are faster than others). The CAD tools at the time of VTR 7 does not consider differences in LUT input delays. @@ -256,7 +256,7 @@ Finally, we choose a switch delay (58 ps) that leads to length 4 wires having a delay equal to that of SIV of 126 ps. This also leads to the switch being 46% of the total wire delay, which is reasonable. --> - + diff --git a/libs/libarchfpga/src/arch_check.h b/libs/libarchfpga/src/arch_check.h index cd154d022ee..bde6ba51013 100644 --- a/libs/libarchfpga/src/arch_check.h +++ b/libs/libarchfpga/src/arch_check.h @@ -55,7 +55,7 @@ void warn_model_missing_timing(const t_model& model, const char* file, uint32_t void check_port_direct_mappings(t_physical_tile_type_ptr physical_tile, t_sub_tile* sub_tile, t_logical_block_type_ptr logical_block); /** - * @brief Checks the timing consistency between tha pb_type and the corresponding model. + * @brief Checks the timing consistency between a pb_type and the corresponding model. * * @param pb_type pb type to check * @param arch architecture data structure diff --git a/libs/libarchfpga/src/arch_util.cpp b/libs/libarchfpga/src/arch_util.cpp index eaf067258e8..3397b3883cd 100644 --- a/libs/libarchfpga/src/arch_util.cpp +++ b/libs/libarchfpga/src/arch_util.cpp @@ -1148,7 +1148,7 @@ void setup_pin_classes(t_physical_tile_type* type) { // as ignored pins (i.e. connections are not created in the rr_graph and // nets connected to the port are ignored as well). type->is_ignored_pin[pin_count] = port.is_clock || port.is_non_clock_global; - // clock pins and other specified global ports are flaged as global + // clock pins and other specified global ports are flagged as global type->is_pin_global[pin_count] = port.is_clock || port.is_non_clock_global; if (port.is_clock) { diff --git a/libs/libarchfpga/src/echo_arch.cpp b/libs/libarchfpga/src/echo_arch.cpp index 91e31b4f997..a5d02d525a6 100644 --- a/libs/libarchfpga/src/echo_arch.cpp +++ b/libs/libarchfpga/src/echo_arch.cpp @@ -23,7 +23,7 @@ static void PrintPb_types_recPower(FILE* Echo, const char* tabs); /* Output the data from architecture data so user can verify it - * was interpretted correctly. */ + * was interpreted correctly. */ void EchoArch(const char* EchoFile, const std::vector& PhysicalTileTypes, const std::vector& LogicalBlockTypes, @@ -420,7 +420,7 @@ static void PrintPb_types_rec(FILE* Echo, const t_pb_type* pb_type, int level, c } else { /*leaf pb with unknown model*/ /*LUT(names) already handled, it naturally has 2 modes. * I/O has no annotations to be displayed - * All other library or user models may have delays specificied, e.g. Tsetup and Tcq + * All other library or user models may have delays specified, e.g. Tsetup and Tcq * Display the additional information*/ std::string pb_type_model_name = models.get_model(pb_type->model_id).name; if (pb_type_model_name != LogicalModels::MODEL_NAMES @@ -633,7 +633,7 @@ static void PrintPb_types_recPower(FILE* Echo, pb_type->pb_type_power->absolute_power_per_instance.dynamic); break; default: - fprintf(Echo, "%s\tpower method: error has occcured\n", tabs); + fprintf(Echo, "%s\tpower method: error has occcurred\n", tabs); break; } } diff --git a/libs/libarchfpga/src/logic_types.h b/libs/libarchfpga/src/logic_types.h index 55c0ea39f0d..a0d7ecc62d6 100644 --- a/libs/libarchfpga/src/logic_types.h +++ b/libs/libarchfpga/src/logic_types.h @@ -92,7 +92,7 @@ typedef vtr::StrongId LogicalModelId; * * There are two types of logical models: * 1) Library Models: These are models that all architectures share. These are - * created in the construtor of this class. + * created in the constructor of this class. * 2) User Models: These are models defined by the user and are created outside * of this class (usually by parsing an architecture file). */ diff --git a/libs/libarchfpga/src/physical_types.h b/libs/libarchfpga/src/physical_types.h index 568a3c52b4b..289044c0fb2 100644 --- a/libs/libarchfpga/src/physical_types.h +++ b/libs/libarchfpga/src/physical_types.h @@ -494,7 +494,7 @@ enum class e_sb_type { * pin_avg_width_offset: Average width offset to specified pin (exact if only a single physical pin instance) * pin_avg_height_offset: Average height offset to specified pin (exact if only a single physical pin instance) * pin_class: The class a pin belongs to - * is_ignored_pin: Whether or not a pin is ignored durring rr_graph generation and routing. + * is_ignored_pin: Whether or not a pin is ignored during rr_graph generation and routing. * This is usually the case for clock pins and other global pins unless the * clock_modeling option is set to route the clock through regular inter-block * wiring or through a dedicated clock network. @@ -998,7 +998,7 @@ struct t_pb_type { * @brief Check if t_pb_type is the root of the pb graph. Root pb_types correspond to a single top level block type and map to a particular type * of location in the FPGA device grid (e.g. Logic, DSP, RAM etc.) * - * @return if t_pb_type is root ot not + * @return if t_pb_type is root or not */ inline bool is_root() const { return parent_mode == nullptr; @@ -1007,7 +1007,7 @@ struct t_pb_type { /** * @brief Check if t_pb_type is a primitive block or equivalently a leaf of the pb graph. * - * @return if t_pb_type is primitive/leaf ot not + * @return if t_pb_type is primitive/leaf or not */ inline bool is_primitive() const { return num_modes == 0; @@ -1298,8 +1298,8 @@ class t_pb_graph_node { * as well), but LUTs A, B and C could still be routed using the parent pb_graph_node's mode "LUTRAM". * Therefore, "LUTs" is marked as illegal and all the LUTs (A, B, C and D) will have a consistent parent pb_graph_node mode, namely "LUTRAM". * - * Usage: cluster_router uses this information to exclude the expansion of a node which has a not cosistent mode. - * Everytime the mode consistency check fails, the index of the mode that causes the conflict is added to this vector. + * Usage: cluster_router uses this information to exclude the expansion of a node which has a not consistent mode. + * Every time the mode consistency check fails, the index of the mode that causes the conflict is added to this vector. * */ std::vector illegal_modes; @@ -1975,7 +1975,7 @@ struct t_arch { bool shrink_boundary; /// Allow routing channels to pass through multi-width and - /// multi-height programable blocks + /// multi-height programmable blocks bool through_channel; /// Allow each output pin of a programmable block to drive the diff --git a/libs/libarchfpga/src/physical_types_util.cpp b/libs/libarchfpga/src/physical_types_util.cpp index ac5f9f2eec8..6467eceef65 100644 --- a/libs/libarchfpga/src/physical_types_util.cpp +++ b/libs/libarchfpga/src/physical_types_util.cpp @@ -661,7 +661,7 @@ std::string block_type_pin_index_to_name(t_physical_tile_type_ptr type, int pin_ return pin_name; } - return ""; + return ""; } std::vector block_type_class_index_to_pin_names(t_physical_tile_type_ptr type, diff --git a/libs/libarchfpga/src/read_fpga_interchange_arch.cpp b/libs/libarchfpga/src/read_fpga_interchange_arch.cpp index b2bb9167de5..3e5bd384ab7 100644 --- a/libs/libarchfpga/src/read_fpga_interchange_arch.cpp +++ b/libs/libarchfpga/src/read_fpga_interchange_arch.cpp @@ -2304,7 +2304,7 @@ struct ArchReader { /* * The generic architecture data is not currently available in the interchange format * therefore, for a very initial implementation, the values are taken from the ones - * used primarly in the Xilinx series7 devices, generated using SymbiFlow. + * used primarily in the Xilinx series7 devices, generated using SymbiFlow. * * As the interchange format develops further, with possibly more details, this function can * become dynamic, allowing for different parameters for the different architectures. diff --git a/libs/libarchfpga/src/read_xml_arch_file.cpp b/libs/libarchfpga/src/read_xml_arch_file.cpp index 272411d636c..f66a130d992 100644 --- a/libs/libarchfpga/src/read_xml_arch_file.cpp +++ b/libs/libarchfpga/src/read_xml_arch_file.cpp @@ -6,7 +6,7 @@ * help the developer build, and traverse tree (this is also sometimes referred to * as the Document Object Model or DOM). * - * For convenience, it often makes sense to use some wraper functions (provided in + * For convenience, it often makes sense to use some wrapper functions (provided in * the pugiutil namespace of libvtrutil) which simplify loading an XML file and * error handling. * @@ -429,7 +429,7 @@ void xml_read_arch(std::string_view arch_file, char* prop = get_attribute(architecture, "version", loc_data, ReqOpt::OPTIONAL).as_string(NULL); if (prop != NULL) { if (atof(prop) > atof(VPR_VERSION)) { - VTR_LOG_WARN( "This architecture version is for VPR %f while your current VPR version is " VPR_VERSION ", compatability issues may arise\n", + VTR_LOG_WARN( "This architecture version is for VPR %f while your current VPR version is " VPR_VERSION ", compatibility issues may arise\n", atof(prop)); } } @@ -444,7 +444,7 @@ void xml_read_arch(std::string_view arch_file, next = get_single_child(architecture, "layout", loc_data); process_layout(next, arch, loc_data, num_of_avail_layers); - // Precess vib_layout + // Process vib_layout next = get_single_child(architecture, "vib_layout", loc_data, ReqOpt::OPTIONAL); if (next) { process_vib_layout(next, arch, loc_data); @@ -2029,7 +2029,7 @@ static void process_fc(pugi::xml_node node, } /* Go through all the port/segment combinations and create the (potentially - * overriden) pin/seg Fc specifications */ + * overridden) pin/seg Fc specifications */ for (size_t iseg = 0; iseg < segments.size(); ++iseg) { for (int icapacity = 0; icapacity < sub_tile->capacity.total(); ++icapacity) { //If capacity > 0, we need t offset the block index by the number of pins per instance @@ -3610,7 +3610,7 @@ static void process_pin_locations(pugi::xml_node Locations, if (!port_pins_with_specified_locations[iinst][port.name].contains(ipin)) { //Missing archfpga_throw(loc_data.filename_c_str(), loc_data.line(Locations), - vtr::string_fmt("Pin '%s[%d].%s[%d]' has no pin location specificed (a location is required for pattern=\"custom\")", + vtr::string_fmt("Pin '%s[%d].%s[%d]' has no pin location specified (a location is required for pattern=\"custom\")", sub_tile->name.c_str(), iinst, port.name, ipin) .c_str()); } @@ -3820,7 +3820,7 @@ static std::vector process_segments(pugi::xml_node parent, if (tmp) { segs[i].name = tmp; } else { - /* if swich block is "custom", then you have to provide a name for segment */ + /* if switch block is "custom", then you have to provide a name for segment */ if (switchblocklist_required) { archfpga_throw(loc_data.filename_c_str(), loc_data.line(node), vtr::string_fmt("No name specified for the segment #%d.\n", i).c_str()); diff --git a/libs/libarchfpga/src/read_xml_arch_file_interposer.h b/libs/libarchfpga/src/read_xml_arch_file_interposer.h index 94e5a5f8c62..37fe1408d1d 100644 --- a/libs/libarchfpga/src/read_xml_arch_file_interposer.h +++ b/libs/libarchfpga/src/read_xml_arch_file_interposer.h @@ -13,7 +13,7 @@ * @brief Parse an tag and its children * * @param interposer_cut_tag xml_node pointing to the tag - * @param loc_data Points to the location in the architecture file where the parser is reading. Used for priting error messages. + * @param loc_data Points to the location in the architecture file where the parser is reading. Used for printing error messages. * @return t_interposer_cut_inf with parsed information of the tag */ t_interposer_cut_inf parse_interposer_cut_tag(pugi::xml_node interposer_cut_tag, const pugiutil::loc_data& loc_data); diff --git a/libs/libarchfpga/src/read_xml_arch_file_noc_tag.cpp b/libs/libarchfpga/src/read_xml_arch_file_noc_tag.cpp index aa415590551..55e00fdd6e8 100644 --- a/libs/libarchfpga/src/read_xml_arch_file_noc_tag.cpp +++ b/libs/libarchfpga/src/read_xml_arch_file_noc_tag.cpp @@ -82,7 +82,7 @@ static void verify_noc_topology(const std::map>& router /** * @brief Parses the connections field in tag under tag. * The user provides the list of routers any given router is connected to - * by the router ids seperated by spaces. For example: + * by the router ids separated by spaces. For example: * connections="1 2 3 4 5" * Go through the connections here and store them. Also make sure the list is legal. * @@ -281,7 +281,7 @@ static void generate_noc_mesh(pugi::xml_node mesh_topology_tag, * * - if we instead used 2 in the distance calculation, the resulting positions would result in * having 2 routers positioned on the start and end of the region. - * This is beacuse we now specified 2 spaces between the region and this allows us to place 2 routers + * This is because we now specified 2 spaces between the region and this allows us to place 2 routers * on the regions edges and one router in the center. * * start end @@ -310,7 +310,7 @@ static void generate_noc_mesh(pugi::xml_node mesh_topology_tag, // calculate router position /* The first and last router of each column or row will be located on the mesh region boundary, - * the remaining routers will be placed within the region and seperated from other routers + * the remaining routers will be placed within the region and separated from other routers * using the distance calculated previously. */ temp_router.device_x_position = (i * horizontal_router_separation) + mesh_region.start_x; @@ -449,7 +449,7 @@ static void process_router(pugi::xml_node router_tag, // check if the user provided a legal router connection list if (!router_connection_list_result) { archfpga_throw(loc_data.filename_c_str(), loc_data.line(router_tag), - "The 'connections' attribute for the router must be a list of integers seperated by spaces, " + "The 'connections' attribute for the router must be a list of integers separated by spaces, " "where each integer represents a router id that the current router is connected to."); } @@ -500,8 +500,8 @@ static bool parse_noc_router_connection_list(pugi::xml_node router_tag, std::vector& connection_list, const std::string& connection_list_attribute_value, std::map>& routers_in_arch_info) { - // we wil be modifying the string so store it in a temporary variable - // additionally, we process substrings seperated by spaces, + // we will be modifying the string so store it in a temporary variable + // additionally, we process substrings separated by spaces, // so we add a space at the end of the string to be able to process the last sub-string std::string modified_attribute_value = connection_list_attribute_value + " "; const std::string delimiter = " "; @@ -520,7 +520,7 @@ static bool parse_noc_router_connection_list(pugi::xml_node router_tag, // convert the connection to an integer single_connection >> converted_connection; - /* we expect the connection list to be a string of integers seperated by spaces, + /* we expect the connection list to be a string of integers separated by spaces, * where each integer represents a router id that the current router is connected to. * So we make sure that the router id was an integer. */ diff --git a/libs/libarchfpga/src/read_xml_arch_file_sg.cpp b/libs/libarchfpga/src/read_xml_arch_file_sg.cpp index 11f9e1976fb..4519ffe4e00 100644 --- a/libs/libarchfpga/src/read_xml_arch_file_sg.cpp +++ b/libs/libarchfpga/src/read_xml_arch_file_sg.cpp @@ -10,7 +10,7 @@ * @brief Parses all tags under a tag. * * @param sg_link_list_tag XML node pointing to the tag. - * @param loc_data Points to the location in the architecture file where the parser is reading. Used for priting error messages. + * @param loc_data Points to the location in the architecture file where the parser is reading. Used for printing error messages. * @return std::vector the information for the sg_links in the sg_link_list. */ static std::vector parse_sg_link_tags(pugi::xml_node sg_link_list_tag, @@ -45,7 +45,7 @@ static std::vector parse_sg_link_tags(pugi::xml_node sg_link_list_tag * @brief Parses all tags under a tag. * * @param sg_pattern_tag XML node pointing to the tag. - * @param loc_data Points to the location in the architecture file where the parser is reading. Used for priting error messages. + * @param loc_data Points to the location in the architecture file where the parser is reading. Used for printing error messages. * @return std::vector contains information of scatter gather locations. */ static std::vector parse_sg_location_tags(pugi::xml_node sg_pattern_tag, diff --git a/libs/libarchfpga/src/read_xml_arch_file_sg.h b/libs/libarchfpga/src/read_xml_arch_file_sg.h index a13fa474721..8a50820630f 100644 --- a/libs/libarchfpga/src/read_xml_arch_file_sg.h +++ b/libs/libarchfpga/src/read_xml_arch_file_sg.h @@ -9,7 +9,7 @@ * @param sg_list_tag XML node pointing to the tag. * @param arch High-level architecture information. This function fills * arch->scatter_gather_patterns with scatter-gather-related information. - * @param loc_data Points to the location in the architecture file where the parser is reading. Used for priting error messages. + * @param loc_data Points to the location in the architecture file where the parser is reading. Used for printing error messages. * @param switches Contains all the architecture switches. Usually same as arch->switches. */ void process_sg_tag(pugi::xml_node sg_list_tag, diff --git a/libs/libarchfpga/src/vib_inf.h b/libs/libarchfpga/src/vib_inf.h index bf50eeb90e5..c7a452daff6 100644 --- a/libs/libarchfpga/src/vib_inf.h +++ b/libs/libarchfpga/src/vib_inf.h @@ -168,7 +168,7 @@ class VibInf { }; /************************* VIB_GRID ***********************************/ -/* Describe different VIB type on different locations by immitating t_grid_loc_def. */ +/* Describe different VIB type on different locations by imitating t_grid_loc_def. */ struct t_vib_grid_loc_spec { t_vib_grid_loc_spec(std::string start, std::string end, std::string repeat, std::string incr) @@ -210,7 +210,7 @@ struct t_vib_grid_loc_def { // the largest priority wins. t_vib_grid_loc_spec x; //Horizontal location specification - t_vib_grid_loc_spec y; //Veritcal location specification + t_vib_grid_loc_spec y; //Vertical location specification }; struct t_vib_layer_def { diff --git a/libs/libpugiutil/src/pugixml_loc.hpp b/libs/libpugiutil/src/pugixml_loc.hpp index 23088fcfcd4..39e093038cf 100644 --- a/libs/libpugiutil/src/pugixml_loc.hpp +++ b/libs/libpugiutil/src/pugixml_loc.hpp @@ -1,7 +1,7 @@ #pragma once /* * This file contains utilities for the PUGI XML parser, - * hanlding the retrieval of line numbers (useful for error messages) + * handling the retrieval of line numbers (useful for error messages) */ #include diff --git a/libs/libpugiutil/src/pugixml_util.cpp b/libs/libpugiutil/src/pugixml_util.cpp index 1353f2114d1..8399e52fc98 100644 --- a/libs/libpugiutil/src/pugixml_util.cpp +++ b/libs/libpugiutil/src/pugixml_util.cpp @@ -181,7 +181,7 @@ void expect_only_children(const pugi::xml_node node, } //Throws a well formatted error if any attribute other than those named in 'attribute_names' are found on 'node' with an additional explanation. -//Note this does not check whether the attribues in 'attribute_names' actually exist. +//Note this does not check whether the attributes in 'attribute_names' actually exist. // // node - The parent xml node // attribute_names - expected attribute names diff --git a/libs/libpugiutil/src/pugixml_util.hpp b/libs/libpugiutil/src/pugixml_util.hpp index 54b27fa8ade..aff31e35eb6 100644 --- a/libs/libpugiutil/src/pugixml_util.hpp +++ b/libs/libpugiutil/src/pugixml_util.hpp @@ -3,11 +3,11 @@ * This file contains utilities for the PUGI XML parser. * * They primarily relate to: - * - Checking for node/attribute exitance and reporting errors if not + * - Checking for node/attribute existence and reporting errors if not * - Misc. utilities like counting tags * * Using these utilities simplifies error handling while manipulating XML - * since the user doesn't need to explicitly check for node/attribute existance + * since the user doesn't need to explicitly check for node/attribute existence * (by default most of these functions will raise exceptions with useful error * messages if the requested item does not exists). */ @@ -142,7 +142,7 @@ void expect_only_children(const pugi::xml_node node, const loc_data& loc_data); //Throws a well formatted error if any attribute other than those named in 'attribute_names' are found on 'node'. -//Note this does not check whether the attribues in 'attribute_names' actually exist. +//Note this does not check whether the attributes in 'attribute_names' actually exist. // // node - The parent xml node // attribute_names - expected attribute names @@ -152,7 +152,7 @@ void expect_only_attributes(const pugi::xml_node node, const loc_data& loc_data); //Throws a well formatted error if any attribute other than those named in 'attribute_names' are found on 'node' with an additional explanation. -//Note this does not check whether the attribues in 'attribute_names' actually exist. +//Note this does not check whether the attributes in 'attribute_names' actually exist. // // node - The parent xml node // attribute_names - expected attribute names diff --git a/libs/librrgraph/src/base/SCHEMA_GENERATOR.md b/libs/librrgraph/src/base/SCHEMA_GENERATOR.md index 5a61deacde7..fe309db37db 100644 --- a/libs/librrgraph/src/base/SCHEMA_GENERATOR.md +++ b/libs/librrgraph/src/base/SCHEMA_GENERATOR.md @@ -42,10 +42,10 @@ generated code. Roughly half of the methods are for the reader interface VPR to disk). The methods starting with `preallocate_`, `add_`, `init_`, and `finish_` -are associated with the reader interface. The reader interface has three additionals methods, `start_load`, `finish_load` and `error_encountered`. +are associated with the reader interface. The reader interface has three additional methods, `start_load`, `finish_load` and `error_encountered`. The methods starting with `get_`, `has_` and `size_` are associated with -the writer interface. The writer interface has two additionals methods, `start_write`, and `finish_write`. +the writer interface. The writer interface has two additional methods, `start_write`, and `finish_write`. #### Load interface diff --git a/libs/librrgraph/src/base/check_rr_graph.cpp b/libs/librrgraph/src/base/check_rr_graph.cpp index c7dc208c5e3..321572d3ae8 100644 --- a/libs/librrgraph/src/base/check_rr_graph.cpp +++ b/libs/librrgraph/src/base/check_rr_graph.cpp @@ -623,8 +623,8 @@ static bool has_adjacent_channel(const RRGraphView& rr_graph, const DeviceGrid& if ((rr_graph.node_xlow(node.id()) == 0 && !rr_graph.is_node_on_specific_side(node.id(), RIGHT)) //left device edge connects only along block's right side || (rr_graph.node_ylow(node.id()) == int(grid.height() - 1) && !rr_graph.is_node_on_specific_side(node.id(), BOTTOM)) //top device edge connects only along block's bottom side - || (rr_graph.node_xlow(node.id()) == int(grid.width() - 1) && !rr_graph.is_node_on_specific_side(node.id(), LEFT)) //right deivce edge connects only along block's left side - || (rr_graph.node_ylow(node.id()) == 0 && !rr_graph.is_node_on_specific_side(node.id(), TOP)) //bottom deivce edge connects only along block's top side + || (rr_graph.node_xlow(node.id()) == int(grid.width() - 1) && !rr_graph.is_node_on_specific_side(node.id(), LEFT)) //right device edge connects only along block's left side + || (rr_graph.node_ylow(node.id()) == 0 && !rr_graph.is_node_on_specific_side(node.id(), TOP)) //bottom device edge connects only along block's top side ) { return false; } diff --git a/libs/librrgraph/src/base/rr_graph_builder.h b/libs/librrgraph/src/base/rr_graph_builder.h index 54fccf3436f..cfe8236ebb5 100644 --- a/libs/librrgraph/src/base/rr_graph_builder.h +++ b/libs/librrgraph/src/base/rr_graph_builder.h @@ -48,7 +48,7 @@ class RRGraphBuilder { /** @brief Return a writable object for the meta data on the edge */ MetadataStorage>& rr_edge_metadata(); - /** @brief Return a writable object fo the incoming edge storage */ + /** @brief Return a writable object for the incoming edge storage */ vtr::vector>& node_in_edge_storage(); /** @brief Return a writable object of the node ptc storage (for tileable routing resource graph) */ @@ -428,7 +428,7 @@ class RRGraphBuilder { inline void reserve_switches(size_t num_switches) { this->rr_switch_inf_.reserve(num_switches); } - /** @brief This function resize node storage to accomidate size RR nodes. */ + /** @brief This function resize node storage to accommodate size RR nodes. */ inline void resize_nodes(size_t size) { node_storage_.resize(size); } @@ -438,7 +438,7 @@ class RRGraphBuilder { } - /** @brief This function resize rr_switch to accomidate size RR Switch. */ + /** @brief This function resize rr_switch to accommodate size RR Switch. */ inline void resize_switches(size_t size) { rr_switch_inf_.resize(size); } diff --git a/libs/librrgraph/src/base/rr_graph_obj.cpp b/libs/librrgraph/src/base/rr_graph_obj.cpp index 2955a65ea80..1d9ea990bb6 100644 --- a/libs/librrgraph/src/base/rr_graph_obj.cpp +++ b/libs/librrgraph/src/base/rr_graph_obj.cpp @@ -177,7 +177,7 @@ RRSegmentId RRGraph::node_segment(const RRNodeId& node) const { * Get the number of configurable input edges of a node * TODO: we would use the node_num_configurable_in_edges() * when the rr_graph edges have been partitioned - * This can avoid unneccessary walkthrough + * This can avoid unnecessary walkthrough */ short RRGraph::node_num_configurable_in_edges(const RRNodeId& node) const { return node_configurable_in_edges(node).size(); @@ -187,7 +187,7 @@ short RRGraph::node_num_configurable_in_edges(const RRNodeId& node) const { * Get the number of configurable output edges of a node * TODO: we would use the node_num_configurable_out_edges() * when the rr_graph edges have been partitioned - * This can avoid unneccessary walkthrough + * This can avoid unnecessary walkthrough */ short RRGraph::node_num_configurable_out_edges(const RRNodeId& node) const { return node_configurable_out_edges(node).size(); @@ -197,7 +197,7 @@ short RRGraph::node_num_configurable_out_edges(const RRNodeId& node) const { * Get the number of non-configurable input edges of a node * TODO: we would use the node_num_configurable_in_edges() * when the rr_graph edges have been partitioned - * This can avoid unneccessary walkthrough + * This can avoid unnecessary walkthrough */ short RRGraph::node_num_non_configurable_in_edges(const RRNodeId& node) const { return node_non_configurable_in_edges(node).size(); @@ -207,7 +207,7 @@ short RRGraph::node_num_non_configurable_in_edges(const RRNodeId& node) const { * Get the number of non-configurable output edges of a node * TODO: we would use the node_num_configurable_out_edges() * when the rr_graph edges have been partitioned - * This can avoid unneccessary walkthrough + * This can avoid unnecessary walkthrough */ short RRGraph::node_num_non_configurable_out_edges(const RRNodeId& node) const { return node_non_configurable_out_edges(node).size(); diff --git a/libs/librrgraph/src/base/rr_graph_obj.h b/libs/librrgraph/src/base/rr_graph_obj.h index a8baa8d3bda..e7650521005 100644 --- a/libs/librrgraph/src/base/rr_graph_obj.h +++ b/libs/librrgraph/src/base/rr_graph_obj.h @@ -34,7 +34,7 @@ * Note: Multiplexers are the most common type * * The switch information are categorized in the rr_switch_inf of RRGraph class. - * rr_switch_inf is created to minimize memory footprint of RRGraph classs + * rr_switch_inf is created to minimize memory footprint of RRGraph class * While the RRG could contain millions (even much larger) of edges, there are only * a limited number of types of switches. * Hence, we use a flyweight pattern to store switch-related information that differs @@ -47,7 +47,7 @@ * If you wish to create a new data structure to represent switches between routing resources, * please follow the flyweight pattern by linking your switch ids to edges only! * - * Guidlines on using the RRGraph data structure + * Guidelines on using the RRGraph data structure * ============================================= * * For those want to access data from RRGraph @@ -86,9 +86,9 @@ * outside the rr_graph header and source files * * After build/modify a RRGraph, please do run a fundamental check, a public accessor. - * to ensure that your RRGraph does not include invalid nodes/edges/switches/segements + * to ensure that your RRGraph does not include invalid nodes/edges/switches/segments * as well as connections. - * The validate() function gurantees the consistency between internal data structures, + * The validate() function guarantees the consistency between internal data structures, * such as the id cross-reference between nodes and edges etc., * so failing it indicates a fatal bug! * This is a must-do check! @@ -265,7 +265,7 @@ class RRGraph { * This is still the case when a logic block has a height > 1 * For CHANX/CHANY, (xlow, ylow) and (xhigh, yhigh) represent * where the routing segment starts and ends. - * Note that our convention alway keeps + * Note that our convention always keeps * xlow <= xhigh and ylow <= yhigh * Therefore, (xlow, ylow) is a starting point for a CHANX/CHANY in Direction::INC * (xhigh, yhigh) is a starting point for a CHANX/CHANY in Direction::DEC @@ -567,7 +567,7 @@ class RRGraph { /* Reserve the lists of nodes, edges, switches etc. to be memory efficient. * This function is mainly used to reserve memory space inside RRGraph, * when adding a large number of nodes/edge/switches/segments, - * in order to avoid memory fragements + * in order to avoid memory fragments * For example: * RRGraph rr_graph; * // Add 1000 CHANX nodes to the RRGraph object diff --git a/libs/librrgraph/src/base/rr_graph_obj_utils.h b/libs/librrgraph/src/base/rr_graph_obj_utils.h index 708f4f389ec..b9e165f317d 100644 --- a/libs/librrgraph/src/base/rr_graph_obj_utils.h +++ b/libs/librrgraph/src/base/rr_graph_obj_utils.h @@ -54,7 +54,7 @@ Container compress_ids(const Container& ids) { } //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. diff --git a/libs/librrgraph/src/base/rr_graph_storage.h b/libs/librrgraph/src/base/rr_graph_storage.h index 54ddefbdf02..5f78430a652 100644 --- a/libs/librrgraph/src/base/rr_graph_storage.h +++ b/libs/librrgraph/src/base/rr_graph_storage.h @@ -92,7 +92,7 @@ struct alignas(16) t_rr_node_data { static_assert(sizeof(t_rr_node_data) == 16, "Check t_rr_node_data size"); static_assert(alignof(t_rr_node_data) == 16, "Check t_rr_node_data size"); -/* t_rr_node_ptc_data is cold data is therefore kept seperate from +/* t_rr_node_ptc_data is cold data is therefore kept separate from * t_rr_node_data. * * ptc_num: Pin, track or class number, depending on rr_node type. * @@ -721,16 +721,16 @@ class t_rr_graph_storage { // initialize edges. All edges must be added prior to calling any // methods that read edge data. // - // Note: Either arch_switch_inf indicies or rr_switch_inf should be + // Note: Either arch_switch_inf indices or rr_switch_inf should be // used with emplace_back_edge and alloc_and_load_edges. Do not mix - // indicies, otherwise things will be break. + // indices, otherwise things will be break. // // The rr_switch_inf switches are remapped versions of the // arch_switch_inf switch indices that are used when we have // different delays and hence different indices based on the fanout // of a switch. Because fanout of the switch can only be computed // after the graph is built, the graph is initially built using - // arch_switch_inf indicies, and then remapped once fanout is + // arch_switch_inf indices, and then remapped once fanout is // determined. // // 2. The following methods read from the edge data, and lock out the @@ -741,7 +741,7 @@ class t_rr_graph_storage { // - remap_rr_node_switch_indices // - mark_edges_as_rr_switch_ids // - // 3. If edge_switch values are arch_switch_inf indicies, + // 3. If edge_switch values are arch_switch_inf indices, // remap_rr_node_switch_indices must be called prior to calling // partition_edges. // @@ -804,17 +804,17 @@ class t_rr_graph_storage { size_t count_rr_switches(const std::vector& arch_switch_inf, t_arch_switch_fanin& arch_switch_fanins); - /** @brief Maps arch_switch_inf indicies to rr_switch_inf indicies. + /** @brief Maps arch_switch_inf indices to rr_switch_inf indices. * * This must be called before partition_edges if edges were created with - * arch_switch_inf indicies. + * arch_switch_inf indices. */ void remap_rr_node_switch_indices(const t_arch_switch_fanin& switch_fanin); - /** @brief Marks that edge switch values are rr switch indicies. + /** @brief Marks that edge switch values are rr switch indices. * * This must be called before partition_edges if edges were created with - * rr_switch_inf indicies. + * rr_switch_inf indices. */ void mark_edges_as_rr_switch_ids(); @@ -856,7 +856,7 @@ class t_rr_graph_storage { std::stable_sort(edge_indices.begin(), edge_indices.end(), comparison_function); // Generic lambda that allocates a 'vec'-sized new vector with all elements set to default value, - // then builds the new vector to have rearranged elements from 'vec' and finaly move the new vector + // then builds the new vector to have rearranged elements from 'vec' and finally move the new vector // to replace vec. Essentially does a permutation on vec based on edge_indices. auto array_rearrange = [&edge_indices] (auto& vec, auto default_value) { diff --git a/libs/librrgraph/src/base/rr_graph_view.h b/libs/librrgraph/src/base/rr_graph_view.h index ca87ef4ea1a..77c0b5b1ce2 100644 --- a/libs/librrgraph/src/base/rr_graph_view.h +++ b/libs/librrgraph/src/base/rr_graph_view.h @@ -96,7 +96,7 @@ class RRGraphView { void operator=(const RRGraphView&) = delete; /* -- Accessors -- */ - /* TODO: The accessors may be turned into private later if they are replacable by 'questionin' + /* TODO: The accessors may be turned into private later if they are replaceable by 'questionin' * kind of accessors */ public: diff --git a/libs/librrgraph/src/base/rr_node.h b/libs/librrgraph/src/base/rr_node.h index e44926013e8..2f733561cfa 100644 --- a/libs/librrgraph/src/base/rr_node.h +++ b/libs/librrgraph/src/base/rr_node.h @@ -11,7 +11,7 @@ // // In general, new code should not use this object, but instead directly // use the t_rr_graph_storage object. However this object remains for -// backwards compability, as described below. +// backwards compatibility, as described below. // // RR node and edges was original stored within the t_rr_node object, the // full RR graph was stored in a std::vector, which was effectively @@ -49,7 +49,7 @@ // void t_rr_graph_storage::set_node_test(RRNodeId, t_type); // // The particular storage method within t_rr_graph_storage depends on the data. -// See t_rr_graph_storage for the storage philosphy within philosophy. +// See t_rr_graph_storage for the storage philosophy within philosophy. // // Second, add the proxy methods to t_rr_node. Method prototypes should be // added in rr_node.h and method implementations should be added in diff --git a/libs/librrgraph/src/base/rr_node_impl.h b/libs/librrgraph/src/base/rr_node_impl.h index 4b5f41d62d8..67b934874eb 100644 --- a/libs/librrgraph/src/base/rr_node_impl.h +++ b/libs/librrgraph/src/base/rr_node_impl.h @@ -1,5 +1,5 @@ #pragma once -// This file provides the inline proxy implemenation for t_rr_node. +// This file provides the inline proxy implementation for t_rr_node. // See the t_rr_node class comment for additional details. #include diff --git a/libs/librrgraph/src/base/rr_rc_data.h b/libs/librrgraph/src/base/rr_rc_data.h index 882682e270b..2ece50f64d2 100644 --- a/libs/librrgraph/src/base/rr_rc_data.h +++ b/libs/librrgraph/src/base/rr_rc_data.h @@ -8,6 +8,6 @@ * If an existing t_rr_rc_data matches the specified R/C it's index * is returned, otherwise the t_rr_rc_data is created. * - * The returned indicies index into DeviceContext.rr_rc_data. + * The returned indices index into DeviceContext.rr_rc_data. */ NodeRCIndex find_create_rr_rc_data(const float R, const float C, std::vector& rr_rc_data); diff --git a/libs/librrgraph/src/base/rr_spatial_lookup.h b/libs/librrgraph/src/base/rr_spatial_lookup.h index 4fa2830be51..a856c24add7 100644 --- a/libs/librrgraph/src/base/rr_spatial_lookup.h +++ b/libs/librrgraph/src/base/rr_spatial_lookup.h @@ -289,6 +289,6 @@ class RRSpatialLookup { /* -- Internal data storage -- */ private: - /* Fast look-up: TODO: Should rework the data type. Currently it is based on a 3-dimensional array mater where some dimensions must always be accessed with a specific index. Such limitation should be overcome */ + /* Fast look-up: TODO: Should rework the data type. Currently it is based on a 3-dimensional array where some dimensions must always be accessed with a specific index. Such limitation should be overcome */ t_rr_node_indices rr_node_indices_; }; diff --git a/libs/librrgraph/src/io/gen/README.gen.md b/libs/librrgraph/src/io/gen/README.gen.md index e27331817ab..2a68877a672 100644 --- a/libs/librrgraph/src/io/gen/README.gen.md +++ b/libs/librrgraph/src/io/gen/README.gen.md @@ -1,5 +1,5 @@ `rr_graph_uxsdcxx.h`, `rr_graph_uxsdcxx_capnp.h` and `rr_graph_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. See `$VTR_DIR/libs/librrgraph/src/base/SCHEMA_GENERATOR.md` for details. diff --git a/libs/librrgraph/src/io/rr_graph.xsd b/libs/librrgraph/src/io/rr_graph.xsd index 0d513a34924..52dc079fb2a 100644 --- a/libs/librrgraph/src/io/rr_graph.xsd +++ b/libs/librrgraph/src/io/rr_graph.xsd @@ -35,7 +35,7 @@ For strings with a set of valid values (e.g. enumerations), the "type" attribute should be the name of a xs:simpleType that defines an - xs:restriction / xs:enumeration. This will be demostrated later. + xs:restriction / xs:enumeration. This will be demonstrated later. --> diff --git a/libs/librrgraph/src/utils/alloc_and_load_rr_indexed_data.cpp b/libs/librrgraph/src/utils/alloc_and_load_rr_indexed_data.cpp index 3e252131258..e6a5d308c28 100644 --- a/libs/librrgraph/src/utils/alloc_and_load_rr_indexed_data.cpp +++ b/libs/librrgraph/src/utils/alloc_and_load_rr_indexed_data.cpp @@ -285,7 +285,7 @@ std::vector find_ortho_cost_index(const RRGraphView& rr_graph, ortho_costs_indices[seg_index] = parallel_axis == e_parallel_axis::X_AXIS ? ortho_costs_indices[seg_index] + num_segments : ortho_costs_indices[seg_index]; } - /*Pertubate indices to make sure all perp seg types have a corresponding perp segment.*/ + /*Perturb indices to make sure all perp seg types have a corresponding perp segment.*/ # ifdef PERTURB_ORTHO_COST_indices std::vector perp_segments; std::unordered_multimap indices_map; diff --git a/libs/librtlnumber/Makefile b/libs/librtlnumber/Makefile index 0e1fd16d510..1a5db7c2e8f 100644 --- a/libs/librtlnumber/Makefile +++ b/libs/librtlnumber/Makefile @@ -2,7 +2,7 @@ # Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and # Dr. Kenneth B. Kent (ken@unb.ca) # for the Reconfigurable Computing Research Lab at the -# Univerity of New Brunswick in Fredericton, New Brunswick, Canada +# University of New Brunswick in Fredericton, New Brunswick, Canada # If the first argument is "run"... ifeq (build,$(firstword $(MAKECMDGOALS))) diff --git a/libs/librtlnumber/README.md b/libs/librtlnumber/README.md index 28054545c95..0b79240c292 100644 --- a/libs/librtlnumber/README.md +++ b/libs/librtlnumber/README.md @@ -4,6 +4,6 @@ Authors: Aaron Graham (aaron.graham@unb.ca, aarongraham9@gmail.com), Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and Dr. Kenneth B. Kent (ken@unb.ca) for the Reconfigurable Computing Research Lab at the - Univerity of New Brunswick in Fredericton, New Brunswick, Canada + University of New Brunswick in Fredericton, New Brunswick, Canada Arbitrary Length Verilog Number Library that can Handle `X` and `Z` inputs. diff --git a/libs/librtlnumber/main.cpp b/libs/librtlnumber/main.cpp index 9a59be4d834..fde8fc4ea3c 100644 --- a/libs/librtlnumber/main.cpp +++ b/libs/librtlnumber/main.cpp @@ -2,7 +2,7 @@ * Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #include diff --git a/libs/librtlnumber/regression_tests/basic_regression_tests.csv b/libs/librtlnumber/regression_tests/basic_regression_tests.csv index 444bf11999e..d15dc4c4dda 100644 --- a/libs/librtlnumber/regression_tests/basic_regression_tests.csv +++ b/libs/librtlnumber/regression_tests/basic_regression_tests.csv @@ -4,7 +4,7 @@ # Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and # Dr. Kenneth B. Kent (ken@unb.ca) # for the Reconfigurable Computing Research Lab at the -# Univerity of New Brunswick in Fredericton, New Brunswick, Canada +# University of New Brunswick in Fredericton, New Brunswick, Canada ##################### # truth test diff --git a/libs/librtlnumber/src/include/internal_bits.hpp b/libs/librtlnumber/src/include/internal_bits.hpp index 0d5c7388470..ba9bd6016ee 100644 --- a/libs/librtlnumber/src/include/internal_bits.hpp +++ b/libs/librtlnumber/src/include/internal_bits.hpp @@ -3,7 +3,7 @@ * Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #ifndef INTERNAL_BITS_HPP @@ -837,7 +837,7 @@ class VNumber { std::string to_vstring(char input_base) { std::string out = ""; char base = tolower(input_base); - bool upercase = (base != input_base); + bool uppercase = (base != input_base); if (this->has_unknown() && (base == 'o' || base == 'h' || base == 'd')) { // hot swap to binary since that is all we can print base = 'b'; @@ -845,17 +845,17 @@ class VNumber { switch (base) { case 'b': - return this->to_string(false, upercase); + return this->to_string(false, uppercase); case 'z': - return this->to_string(false, upercase); + return this->to_string(false, uppercase); case 'u': return this->to_Ustring(false); case 'o': - return this->to_log2radix(3, false, upercase); + return this->to_log2radix(3, false, uppercase); case 'd': - return this->to_base10(false, upercase); + return this->to_base10(false, uppercase); case 'h': - return this->to_log2radix(4, false, upercase); + return this->to_log2radix(4, false, uppercase); case 's': return this->bitstring.to_printable(); case 'c': diff --git a/libs/librtlnumber/src/include/rtl_int.hpp b/libs/librtlnumber/src/include/rtl_int.hpp index 41bead2a797..f9cef219c6e 100644 --- a/libs/librtlnumber/src/include/rtl_int.hpp +++ b/libs/librtlnumber/src/include/rtl_int.hpp @@ -3,7 +3,7 @@ * Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #ifndef RTL_INT_H diff --git a/libs/librtlnumber/src/include/rtl_utils.hpp b/libs/librtlnumber/src/include/rtl_utils.hpp index 4813bba457f..af0c019a578 100644 --- a/libs/librtlnumber/src/include/rtl_utils.hpp +++ b/libs/librtlnumber/src/include/rtl_utils.hpp @@ -3,7 +3,7 @@ * Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #ifndef RTL_UTILS_H diff --git a/libs/librtlnumber/src/rtl_int.cpp b/libs/librtlnumber/src/rtl_int.cpp index 47a06828f6b..fb49cf15d9e 100644 --- a/libs/librtlnumber/src/rtl_int.cpp +++ b/libs/librtlnumber/src/rtl_int.cpp @@ -3,7 +3,7 @@ * Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #include diff --git a/libs/librtlnumber/src/rtl_utils.cpp b/libs/librtlnumber/src/rtl_utils.cpp index 8989456aa2d..c1b50d17df8 100644 --- a/libs/librtlnumber/src/rtl_utils.cpp +++ b/libs/librtlnumber/src/rtl_utils.cpp @@ -3,7 +3,7 @@ * Alexandrea Demmings (alexandrea.demmings@unb.ca, lxdemmings@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #include "rtl_utils.hpp" diff --git a/libs/librtlnumber/unit_test/Makefile b/libs/librtlnumber/unit_test/Makefile index a872a59221e..73f9e3087d5 100644 --- a/libs/librtlnumber/unit_test/Makefile +++ b/libs/librtlnumber/unit_test/Makefile @@ -2,7 +2,7 @@ # Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and # Dr. Kenneth B. Kent (ken@unb.ca) # for the Reconfigurable Computing Research Lab at the -# Univerity of New Brunswick in Fredericton, New Brunswick, Canada +# University of New Brunswick in Fredericton, New Brunswick, Canada # If the first argument is "run"... ifeq (build,$(firstword $(MAKECMDGOALS))) diff --git a/libs/librtlnumber/unit_test/verilog_bits.cpp b/libs/librtlnumber/unit_test/verilog_bits.cpp index d9a239997a6..d940ec0637f 100644 --- a/libs/librtlnumber/unit_test/verilog_bits.cpp +++ b/libs/librtlnumber/unit_test/verilog_bits.cpp @@ -2,7 +2,7 @@ * Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and * Dr. Kenneth B. Kent (ken@unb.ca) * for the Reconfigurable Computing Research Lab at the - * Univerity of New Brunswick in Fredericton, New Brunswick, Canada + * University of New Brunswick in Fredericton, New Brunswick, Canada */ #include "internal_bits.hpp" diff --git a/libs/librtlnumber/verify_librtlnumber.sh b/libs/librtlnumber/verify_librtlnumber.sh index 08b7ef09d91..ffd4641952b 100755 --- a/libs/librtlnumber/verify_librtlnumber.sh +++ b/libs/librtlnumber/verify_librtlnumber.sh @@ -3,7 +3,7 @@ # Jean-Philippe Legault (jlegault@unb.ca, jeanphilippe.legault@gmail.com) and # Dr. Kenneth B. Kent (ken@unb.ca) # for the Reconfigurable Computing Research Lab at the -# Univerity of New Brunswick in Fredericton, New Brunswick, Canada +# University of New Brunswick in Fredericton, New Brunswick, Canada # trap ctrl-c and call ctrl_c() trap ctrl_c INT @@ -49,7 +49,7 @@ for INPUT in ${0%/*}/regression_tests/*.csv; do #glob whitespace from line and remove everything after comment input_line=$(echo ${input_line} | tr -d '[:space:]' | cut -d '#' -f1) - #flip escaped commas to 'ESCAPED_COMMA' to safeguard agains having them as csv separator + #flip escaped commas to 'ESCAPED_COMMA' to safeguard against having them as csv separator input_line=$(echo ${input_line} | sed 's/\\\,/ESCAPED_COMMA/g') #skip empty lines diff --git a/libs/libvqm/vqm_common.c b/libs/libvqm/vqm_common.c index ba6199d178a..9bdb2efdac2 100644 --- a/libs/libvqm/vqm_common.c +++ b/libs/libvqm/vqm_common.c @@ -17,12 +17,12 @@ // interconnections. (TC) // April 20, 2005 - Adding code to handle concatenation statements that are implicit in the // instantiation of a module. (TC) -// March 4, 2013 - Modifying code to perform a couting pass followed by an allocation +// March 4, 2013 - Modifying code to perform a counting pass followed by an allocation // pass to decrease memory fragmentation by reducing the number of realloc // calls. Additionally remove linear growth regieme for array allocation, // as this will also cause memory fragmentaiton. -// Modify pointer-integer casts ot use uintptr_t which is -// gaurenteed to match the size of a pointer on any platform. This prevents +// Modify pointer-integer casts to use uintptr_t which is +// guaranteed to match the size of a pointer on any platform. This prevents // bad addresses being generated due to sign extension when converting from // a 32 bit integer type to a 64 bit pointer type. // Also fixed various compiler warnings from casting and signed/unsigned @@ -361,7 +361,7 @@ t_pin_def *add_pin(char *name, int left, int right, t_pin_def_type type, t_parse pin_hash->size = 2*parse_info->number_of_pins; } - //Append the element, the position is one less thatn the size of the array + //Append the element, the position is one less than the size of the array //which is returned by append_array_element size_t position = append_array_element( (intptr_t) pin, pin_list) - 1; @@ -689,7 +689,7 @@ void insert_hash(char* key, size_t value, t_hash_table* hash_table) /* Inserts the key, value pair into the hash_table */ { - //Find the emtpy slot for this key, or the last member of the linked list + //Find the empty slot for this key, or the last member of the linked list //in the slot t_hash_elem* entry = get_hash_entry(key, hash_table); @@ -698,7 +698,7 @@ void insert_hash(char* key, size_t value, t_hash_table* hash_table) if(strcmp(key, entry->key) == 0) { //Duplicate entry - printf("Warning: atempting to add duplicate hash entry for key: '%s'. No action taken.\n", key); + printf("Warning: attempting to add duplicate hash entry for key: '%s'. No action taken.\n", key); return; //Do nothing } else { @@ -897,7 +897,7 @@ t_node_port_association *create_node_port_association(char *port_name, int port_ t_array_ref *associate_identifier_with_port_name(t_identifier_pass *identifier, char *port_name, int port_index) -/* Given a port and an identifier, create an association between them. An association is bascially +/* Given a port and an identifier, create an association between them. An association is basically * a structure that states that a named port is connected to a particular bus or a single wire from * a bus. */ @@ -1165,7 +1165,7 @@ void add_concatenation_assignments(t_array_ref *con_array, t_pin_def *target_pin * assignment: * assign a[2] = b[1]; * - * And so on. The final two assignemnts are: + * And so on. The final two assignments are: * assign a[1] = b[0]; * assign a[0] = c; */ @@ -1202,7 +1202,7 @@ void add_concatenation_assignments(t_array_ref *con_array, t_pin_def *target_pin } pin = locate_net_by_name(source->name); - /* Iterate through all wires. The trick here is count the wire indicies + /* Iterate through all wires. The trick here is count the wire indices * from left to right (either in increasing or decreasing order). */ for( wire_index = pin->left; @@ -1306,7 +1306,7 @@ void define_instance_parameter(t_identifier_pass *identifier, char *parameter_na uintptr_t *allocate_array(int element_count) -/* This funciton allocates the memory for the specified array. The size is specified in +/* This function allocates the memory for the specified array. The size is specified in * number of elements, not number of bytes. When allocating memory this function will * multiply the element_count by sizeof(int). */ @@ -1324,7 +1324,7 @@ uintptr_t *allocate_array(int element_count) void deallocate_array(uintptr_t *array, size_t element_count, void (*free_element)(void *element)) -/* This funciton frees the memory allocated by the array. You must pass +/* This function frees the memory allocated by the array. You must pass * a function that frees the memory allocated for the elements of the array. * If NULL is passed for that function then the elements themselves will not be freed. * Use with care. @@ -1347,7 +1347,7 @@ void deallocate_array(uintptr_t *array, size_t element_count, void (*free_elemen void **reallocate_array(t_array_ref* array_ref, int new_element_count) -/* This funciton reallocates the memory for the specified array. The size is specified in +/* This function reallocates the memory for the specified array. The size is specified in * number of elements, not number of bytes. When reallocating memory this function will * multiply the element_count by sizeof(int). */ diff --git a/libs/libvqm/vqm_dll.h b/libs/libvqm/vqm_dll.h index 63e228e3819..b2460908690 100644 --- a/libs/libvqm/vqm_dll.h +++ b/libs/libvqm/vqm_dll.h @@ -30,7 +30,7 @@ * Array of pins: * The array of pins is an array of t_pin_def structures. The t_pin_def structure contains the name of a pin, or a wire, * the number of bits this pin, or wire, uses and a type. To specify the number of bits a pin uses, the left and the right index - * of a pin are specified. When the wire contains only one bit, the left and right indicies are equal to 0. Examples: + * of a pin are specified. When the wire contains only one bit, the left and right indices are equal to 0. Examples: * a) input a; -> (name = "a", left = 0, right = 0, type = PIN_INPUT) * b) output b[2:1];-> (name = "b", left = 2, right = 1, type = PIN_OUTPUT) * c) inout c[1:2]; -> (name = "c", left = 1, right = 2, type = PIN_INOUT) @@ -66,7 +66,7 @@ * NOTES/REVISIONS: * April 21, 2005 - Modified the t_node_port_association structure to include * an index to the port wire. This allows for direct association - * between a wire an a particular port. This change was necessary to accomodate + * between a wire an a particular port. This change was necessary to accommodate * changes to the VQM file format, specifically to allow concat statements to be used * as parameters in connection lists. (TC) * June 1, 2005 - Only one warning may be produced when compiling this DLL. It should be @@ -83,7 +83,7 @@ // from a DLL simpler. All files within this DLL are compiled with the VQM_DLL_EXPORTS // symbol defined on the command line. this symbol should not be defined on any project // that uses this DLL. This way any other project whose source files include this file see -// VQM_DLL_API functions as being imported from a DLL, wheras this DLL sees symbols +// VQM_DLL_API functions as being imported from a DLL, whereas this DLL sees symbols // defined with this macro as being exported. #ifdef VQM_DLL_EXPORTS diff --git a/libs/libvqm/vqm_parser.y b/libs/libvqm/vqm_parser.y index 743cbe63527..85e04fc84b9 100644 --- a/libs/libvqm/vqm_parser.y +++ b/libs/libvqm/vqm_parser.y @@ -209,7 +209,7 @@ AssignStatement: TOKEN_ASSIGN Identifier '=' RValue ';' { target_wire_index = target_id->index; } - /* Iterate through all wires. The trick here is count the wire indicies + /* Iterate through all wires. The trick here is count the wire indices * from left to right (either in increasing or decreasing order as may be the case). */ for( wire_index = pin->left; ((pin->left > pin->right) ? (wire_index >= pin->right) : (wire_index <= pin->right)); @@ -747,7 +747,7 @@ PinType: TOKEN_INPUT { $$ = $1; } int yyerror(t_parse_info* parse_info, const char *s) { - sprintf(most_recent_error, "%s occured at line %i: %s\r\n", s, yylineno, yytext); + sprintf(most_recent_error, "%s occurred at line %i: %s\r\n", s, yylineno, yytext); return 0; } diff --git a/libs/libvtrcapnproto/CMakeLists.txt b/libs/libvtrcapnproto/CMakeLists.txt index 0f66a10856a..aae9061ed28 100644 --- a/libs/libvtrcapnproto/CMakeLists.txt +++ b/libs/libvtrcapnproto/CMakeLists.txt @@ -2,7 +2,7 @@ include(GNUInstallDirs) if(NOT MSCV) # These flags generate noisy but non-bug warnings when using lib kj, - # supress them. + # suppress them. set(WARN_FLAGS_TO_DISABLE -Wno-undef -Wno-non-virtual-dtor diff --git a/libs/libvtrcapnproto/README.md b/libs/libvtrcapnproto/README.md index 38187e0752e..e54b1d2524d 100644 --- a/libs/libvtrcapnproto/README.md +++ b/libs/libvtrcapnproto/README.md @@ -17,7 +17,7 @@ capnproto can be broken down into 3 parts: - A library The schema language is used to define messages. Each message must have an -explcit capnproto schema, which are stored in files suffixed with ".capnp". +explicit capnproto schema, which are stored in files suffixed with ".capnp". The capnproto documentation for how to write these schema files can be found here: https://capnproto.org/language.html @@ -72,7 +72,7 @@ actual header file will appear in the CMake build directory Writing capnproto binary files to text ====================================== -The `capnp` tool (found in the CMake build directiory +The `capnp` tool (found in the CMake build directory `libs/EXTERNAL/capnproto/c++/src/capnp`) can be used to convert from a binary capnp message to a textual form. diff --git a/libs/libvtrcapnproto/gen/README.gen.md b/libs/libvtrcapnproto/gen/README.gen.md index 838b546de8b..948dd76bc02 100644 --- a/libs/libvtrcapnproto/gen/README.gen.md +++ b/libs/libvtrcapnproto/gen/README.gen.md @@ -1,4 +1,4 @@ `rr_graph_uxsdcxx.capnp` is generated via uxsdcxx and is checked in to -avoid requiring python3 and the uxsdcxx depedencies to build VPR. +avoid requiring python3 and the uxsdcxx dependencies to build VPR. See `vpr/src/route/gen/SCHEMA_GENERATOR.md` for details. diff --git a/libs/libvtrcapnproto/serdes_utils.h b/libs/libvtrcapnproto/serdes_utils.h index 17ba042faa4..ec0a2985cf0 100644 --- a/libs/libvtrcapnproto/serdes_utils.h +++ b/libs/libvtrcapnproto/serdes_utils.h @@ -5,7 +5,7 @@ #include #include -// Platform indepedent way to file message to a file on disk. +// Platform independent way to file message to a file on disk. void writeMessageToFile(const std::string& file, ::capnp::MessageBuilder* builder); diff --git a/libs/libvtrutil/cmake/modules/GetGitRevisionDescription.cmake b/libs/libvtrutil/cmake/modules/GetGitRevisionDescription.cmake index 9f54191298b..0b1ed5c570d 100644 --- a/libs/libvtrutil/cmake/modules/GetGitRevisionDescription.cmake +++ b/libs/libvtrutil/cmake/modules/GetGitRevisionDescription.cmake @@ -61,7 +61,7 @@ get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH) # function returns an empty string via _git_dir_var. # # Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and -# neither foo nor bar contain a file/directory .git. This wil return +# neither foo nor bar contain a file/directory .git. This will return # C:/bla/.git # function(_git_find_closest_git_dir _start_dir _git_dir_var) diff --git a/libs/libvtrutil/src/vtr_array_view.h b/libs/libvtrutil/src/vtr_array_view.h index 4f1ca034fac..e2abc7c9bdd 100644 --- a/libs/libvtrutil/src/vtr_array_view.h +++ b/libs/libvtrutil/src/vtr_array_view.h @@ -143,7 +143,7 @@ class array_view { * * The main use of this container is to behave like a std::span which is * indexed by a vtr::StrongId instead of size_t. It assumes that K is explicitly - * convertable to size_t + * convertible to size_t * (i.e. via operator size_t()), and can be explicitly constructed from a size_t. */ template @@ -200,7 +200,7 @@ class array_view_id : private array_view { public: /** - * @brief Iterator class which is convertable to the key_type + * @brief Iterator class which is convertible to the key_type * * This allows end-users to call the parent class's keys() member * to iterate through the keys with a range-based for loop @@ -220,7 +220,7 @@ class array_view_id : private array_view { /** * @brief Note * - * vtr::vector assumes that the key time is convertable to size_t and + * vtr::vector assumes that the key time is convertible to size_t and * that all the underlying IDs are zero-based and contiguous. That means * we can just increment the underlying Id to build the next key. */ diff --git a/libs/libvtrutil/src/vtr_error.h b/libs/libvtrutil/src/vtr_error.h index 9fd4015d3f7..0508e81a715 100644 --- a/libs/libvtrutil/src/vtr_error.h +++ b/libs/libvtrutil/src/vtr_error.h @@ -26,7 +26,7 @@ namespace vtr { * * Example Usage: * - * // creating and throwing an exception with a VtrError container that has an error occuring in file "error_file.txt" at line number 1 + * // creating and throwing an exception with a VtrError container that has an error occurring in file "error_file.txt" at line number 1 * * throw vtr::VtrError("This is a program terminating error!", "error_file.txt", 1); * diff --git a/libs/libvtrutil/src/vtr_expr_eval.cpp b/libs/libvtrutil/src/vtr_expr_eval.cpp index 1099065b5c0..b43d1f9d6df 100644 --- a/libs/libvtrutil/src/vtr_expr_eval.cpp +++ b/libs/libvtrutil/src/vtr_expr_eval.cpp @@ -800,7 +800,7 @@ static bool is_variable(const std::string& var_name) { return false; } -//returns the length of the substring consisting of valid vairable characters from +//returns the length of the substring consisting of valid variable characters from //the start of the string static int identifier_length(const char* str) { int ichar = 0; diff --git a/libs/libvtrutil/src/vtr_expr_eval.h b/libs/libvtrutil/src/vtr_expr_eval.h index 15e8211e2a3..b7bd5acbd9f 100644 --- a/libs/libvtrutil/src/vtr_expr_eval.h +++ b/libs/libvtrutil/src/vtr_expr_eval.h @@ -187,10 +187,10 @@ class Formula_Object { } else if (data.op == E_OP_AA) { return "+="; } else { - return "???"; //Unkown + return "???"; //Unknown } } else { - return "???"; //Unkown + return "???"; //Unknown } } }; diff --git a/libs/libvtrutil/src/vtr_flat_map.h b/libs/libvtrutil/src/vtr_flat_map.h index 1210c2a14db..f449905d8b0 100644 --- a/libs/libvtrutil/src/vtr_flat_map.h +++ b/libs/libvtrutil/src/vtr_flat_map.h @@ -44,7 +44,7 @@ flat_map2 make_flat_map2(std::vector>&& vec) { * This container is typically useful in the following scenarios: * - Reduced memory usage if key/value are small (std::map needs to store pointers to * other BST nodes which can add substantial overhead for small keys/values) - * - Faster search/iteration by exploiting data locality (all elments are in continguous + * - Faster search/iteration by exploiting data locality (all elements are in contiguous * memory enabling better spatial locality) * * The container deviates from the behaviour of std::map in the following important ways: @@ -53,7 +53,7 @@ flat_map2 make_flat_map2(std::vector>&& vec) { * * The slow insertion/erase performance makes this container poorly suited to maps that * frequently add/remove new keys. If this is required you likely want std::map or - * std::unordered_map. However if the map is constructed once and then repeatedly quieried, + * std::unordered_map. However if the map is constructed once and then repeatedly queried, * consider using the range or vector-based constructors which initializes the flat_map in * O(NlogN) time. */ diff --git a/libs/libvtrutil/src/vtr_geometry.h b/libs/libvtrutil/src/vtr_geometry.h index edac3289b6a..c20ddddff2e 100644 --- a/libs/libvtrutil/src/vtr_geometry.h +++ b/libs/libvtrutil/src/vtr_geometry.h @@ -142,7 +142,7 @@ class Rect { ///@brief xmax coordinate T xmax() const; - ///@brief ymin coodrinate + ///@brief ymin coordinate T ymin() const; ///@brief ymax coordinate @@ -275,7 +275,7 @@ class Line { typedef vtr::Range point_range; public: //Constructors - ///@brief contructor + ///@brief constructor Line(std::vector> line_points); public: //Accessors diff --git a/libs/libvtrutil/src/vtr_linear_map.h b/libs/libvtrutil/src/vtr_linear_map.h index ab0d533dc47..f02150c87f8 100644 --- a/libs/libvtrutil/src/vtr_linear_map.h +++ b/libs/libvtrutil/src/vtr_linear_map.h @@ -12,7 +12,7 @@ namespace vtr { * The main use of this container is to behave like a std::map which is optimized to hold * mappings between a dense linear range of keys (e.g. vtr::StrongId). * - * Requires that K be convertable to size_t with the size_t operator (i.e. size_t()), and + * Requires that K be convertible to size_t with the size_t operator (i.e. size_t()), and * that the conversion results in a linearly increasing index into the underlying vector. * Also requires that K() return the sentinel value used to mark invalid entries. * @@ -286,7 +286,7 @@ class linear_map { /* * This is a work around for the fact that there is no conversion between a const_iterator and iterator. * - * We intiailize i to the start of the container and then advance it by + * We initialize i to the start of the container and then advance it by * the distance to const_iter. The resulting i points to the same element * as const_iter * diff --git a/libs/libvtrutil/src/vtr_math.h b/libs/libvtrutil/src/vtr_math.h index 2437296ba8f..d6e215df1ec 100644 --- a/libs/libvtrutil/src/vtr_math.h +++ b/libs/libvtrutil/src/vtr_math.h @@ -88,7 +88,7 @@ ResultTy median_presorted(const Container& c) { } /** - * @brief Returns the geometric mean of the elments in range [first, last) + * @brief Returns the geometric mean of the elements in range [first, last) * * To avoid potential round-off issues we transform the standard formula: * @@ -120,7 +120,7 @@ double geomean(const Container& c) { return geomean(std::begin(c), std::end(c)); } -///@brief Returns the arithmatic mean of the elements in range [first, last) +///@brief Returns the arithmetic mean of the elements in range [first, last) template double arithmean(const InputIterator first, const InputIterator last, double init = 0.) { double sum = init; diff --git a/libs/libvtrutil/src/vtr_ndmatrix.h b/libs/libvtrutil/src/vtr_ndmatrix.h index ef7e60ebdf1..dea693e8ba0 100644 --- a/libs/libvtrutil/src/vtr_ndmatrix.h +++ b/libs/libvtrutil/src/vtr_ndmatrix.h @@ -30,7 +30,7 @@ class NdMatrixProxy { * @brief Construct a matrix proxy object * * @param dim_sizes: Array of dimension sizes - * @param dim_stride: The stride of this dimension (i.e. how many element in memory between indicies of this dimension) + * @param dim_stride: The stride of this dimension (i.e. how many element in memory between indices of this dimension) * @param offset: The offset from the start that this sub-matrix starts at. * @param start: Pointer to the start of the base NDMatrix of this proxy */ @@ -88,7 +88,7 @@ class NdMatrixProxy { * @brief Construct a 1-d matrix proxy object * * @param dim_sizes: Array of dimension sizes - * @param dim_stride: The stride of this dimension (i.e. how many element in memory between indicies of this dimension) + * @param dim_stride: The stride of this dimension (i.e. how many element in memory between indices of this dimension) * @param offset: The offset from the start that this sub-matrix starts at. * @param start: Pointer to the start of the base NDMatrix of this proxy */ @@ -116,7 +116,7 @@ class NdMatrixProxy { } /** - * @brief Backward compitability + * @brief Backward compitibility * * For legacy compatibility (i.e. code expecting a pointer) we allow this base dimension * case to retrieve a raw pointer to the last dimension elements. @@ -169,7 +169,7 @@ class NdMatrixProxy { * This should improve memory usage (no extra pointers to store for each dimension), * and cache locality (less indirection via pointers, predictable strides). * - * The indicies are calculated based on the dimensions to access the appropriate elements. + * The indices are calculated based on the dimensions to access the appropriate elements. * Since the indexing calculations are visible to the compiler at compile time they can be * optimized to be efficient. */ diff --git a/libs/libvtrutil/src/vtr_ndoffsetmatrix.h b/libs/libvtrutil/src/vtr_ndoffsetmatrix.h index 3272d1abe1d..ec87840815b 100644 --- a/libs/libvtrutil/src/vtr_ndoffsetmatrix.h +++ b/libs/libvtrutil/src/vtr_ndoffsetmatrix.h @@ -60,7 +60,7 @@ class NdOffsetMatrixProxy { * * dim_ranges: Array of DimRange objects * idim: The dimension associated with this proxy - * dim_stride: The stride of this dimension (i.e. how many element in memory between indicies of this dimension) + * dim_stride: The stride of this dimension (i.e. how many element in memory between indices of this dimension) * start: Pointer to the start of the sub-matrix this proxy represents */ NdOffsetMatrixProxy(const DimRange* dim_ranges, size_t idim, size_t dim_stride, T* start) @@ -113,7 +113,7 @@ class NdOffsetMatrixProxy { * @brief Construct a matrix proxy object * * - dim_ranges: Array of DimRange objects - * - dim_stride: The stride of this dimension (i.e. how many element in memory between indicies of this dimension) + * - dim_stride: The stride of this dimension (i.e. how many element in memory between indices of this dimension) * - start: Pointer to the start of the sub-matrix this proxy represents */ NdOffsetMatrixProxy(const DimRange* dim_ranges, size_t idim, size_t dim_stride, T* start) diff --git a/libs/libvtrutil/src/vtr_pair_util.h b/libs/libvtrutil/src/vtr_pair_util.h index be5dd4b9282..969628e8501 100644 --- a/libs/libvtrutil/src/vtr_pair_util.h +++ b/libs/libvtrutil/src/vtr_pair_util.h @@ -4,7 +4,7 @@ namespace vtr { /** - * @brief Iterator which derefernces the 'first' element of a std::pair iterator + * @brief Iterator which dereferences the 'first' element of a std::pair iterator */ template class pair_first_iter { @@ -48,7 +48,7 @@ class pair_first_iter { }; /** - *Iterator which derefernces the 'second' element of a std::pair iterator + *Iterator which dereferences the 'second' element of a std::pair iterator */ template class pair_second_iter { diff --git a/libs/libvtrutil/src/vtr_ragged_matrix.h b/libs/libvtrutil/src/vtr_ragged_matrix.h index de51eee9114..ed5e2d1a222 100644 --- a/libs/libvtrutil/src/vtr_ragged_matrix.h +++ b/libs/libvtrutil/src/vtr_ragged_matrix.h @@ -31,7 +31,7 @@ namespace vtr { * where all elements are laid out contiguiously (one row * after another). * - * Expects Index0 and Index1 to be convertable to size_t. + * Expects Index0 and Index1 to be convertible to size_t. */ template class FlatRaggedMatrix { diff --git a/libs/libvtrutil/src/vtr_range.h b/libs/libvtrutil/src/vtr_range.h index 2692a5715bc..2d15e81b737 100644 --- a/libs/libvtrutil/src/vtr_range.h +++ b/libs/libvtrutil/src/vtr_range.h @@ -7,7 +7,7 @@ namespace vtr { * @brief The vtr::Range template models a range defined by two iterators of type T. * * It allows conveniently returning a range from a single function call - * without having to explicity expose the underlying container, or make two + * without having to explicitly expose the underlying container, or make two * explicit calls to retrieve the associated begin and end iterators. * It also enables the easy use of range-based-for loops. * @@ -15,7 +15,7 @@ namespace vtr { * * class My Data { * public: - * typdef std::vector::const_iterator my_iter; + * typedef std::vector::const_iterator my_iter; * vtr::Range data(); * ... * private: diff --git a/libs/libvtrutil/src/vtr_sentinels.h b/libs/libvtrutil/src/vtr_sentinels.h index ff48f897100..6d7be6ea966 100644 --- a/libs/libvtrutil/src/vtr_sentinels.h +++ b/libs/libvtrutil/src/vtr_sentinels.h @@ -2,12 +2,12 @@ /** * @file - * @brief This header defines different sentinal value classes + * @brief This header defines different sentinel value classes */ namespace vtr { /** - * @brief The Default sentinal value class + * @brief The Default sentinel value class * * Some specialized containers like vtr::linear_map and * vtr::vector_map require sentinel values to mark invalid/uninitialized diff --git a/libs/libvtrutil/src/vtr_small_vector.h b/libs/libvtrutil/src/vtr_small_vector.h index 5aa1c89f781..db76dbaaaec 100644 --- a/libs/libvtrutil/src/vtr_small_vector.h +++ b/libs/libvtrutil/src/vtr_small_vector.h @@ -62,7 +62,7 @@ struct short_format { * std::vector's characteristics. * * For short vectors vtr::small_vector will try to store elements in-place (i.e. within the - * vtr::small_vector object) instead of dynamically allocating an array (by re-using the + * vtr::small_vector object) instead of dynamically allocating an array (by reusing the * internal storage for the pointer, size and capacity). Whether this is possible depends on * the size and alignment requirements of the value type, as compared to * vtr::small_vector. If in-place storage is not possible (e.g. due to a large value @@ -251,7 +251,7 @@ class small_vector { } /** - * @brief Reserve memory for a spicific number of elemnts + * @brief Reserve memory for a specific number of elements * * Don't change capacity unless requested number of elements is both: * - More than the short capacity (no need to reserve up to short capacity) @@ -533,7 +533,7 @@ class small_vector { * @brief Copy short data into long * * Note that the long format contains only basic data types with no destructors to call, - * so we can use uninitialzed copy + * so we can use uninitialized copy */ std::uninitialized_copy(short_vec.short_.begin(), short_vec.short_.end(), long_vec.short_.data_); long_vec.short_.size_ = short_vec.size(); @@ -622,7 +622,7 @@ class small_vector { short_ = other.short_; } else { if (!is_short() && capacity() >= other.size()) { - //Re-use existing buffer, since it has sufficient capacity + //Reuse existing buffer, since it has sufficient capacity destruct_elements(); } else { @@ -762,7 +762,7 @@ class small_vector { * @brief set the size * * The two data (short/long) are padded to - * ensure that thier size_ members area always + * ensure that their size_ members area always * aligned, allowing is to set the size directly * for both formats */ @@ -836,7 +836,7 @@ class small_vector { private: //Data /* - * The object data storage is re-used between the long and short formats. + * The object data storage is reused between the long and short formats. * * If the capacity is small (less than or equal to SHORT_CAPACITY) the * short format (which stores element in-place) is used. Otherwise the diff --git a/libs/libvtrutil/src/vtr_string_interning.h b/libs/libvtrutil/src/vtr_string_interning.h index ad31f6cbeb9..5ae3fbe2634 100644 --- a/libs/libvtrutil/src/vtr_string_interning.h +++ b/libs/libvtrutil/src/vtr_string_interning.h @@ -19,7 +19,7 @@ * * Interned strings (interned_string) that come from the same internment * object (string_internment) can safely be checked for equality and hashed - * without touching the underlying string. Lexigraphical comparisons (e.g. <) + * without touching the underlying string. Lexicographical comparisons (e.g. <) * requires reconstructing the string. * * Basic usage: @@ -75,7 +75,7 @@ typedef StrongId StringId; * Number of bytes to represent the StringId. This implies a maximum number of unique strings available equal to (1 << (kBytesPerId*CHAR_BIT)). */ constexpr size_t kBytesPerId = 3; -///@brief Maximum number of splits to accomidate before just interning the entire string. +///@brief Maximum number of splits to accommodate before just interning the entire string. constexpr size_t kMaxParts = 3; ///@brief Number of bytes to represent the number of splits present in an interned string. constexpr size_t kSizeSize = 1; @@ -90,7 +90,7 @@ static_assert((1 << (CHAR_BIT * kSizeSize)) > kMaxParts, "Size of size data is t * This object is much heavier memory wise than interned_string, so do not * store these. * - * This iterator only accomidates the forward_iterator concept. + * This iterator only accommodates the forward_iterator concept. * * Do no construct this iterator directly. Use either * bound_interned_string::begin/end or interned_string;:begin/end. @@ -407,7 +407,7 @@ class string_internment { // FIXME: This storage scheme does store 2x memory for the strings storage, // however it does avoid having to be concerned with what happens when - // strings_ resizes, so for a simplier initial implementation, this is the + // strings_ resizes, so for a simpler initial implementation, this is the // approach taken. vtr::vector strings_; std::string temporary_; diff --git a/libs/libvtrutil/src/vtr_strong_id.h b/libs/libvtrutil/src/vtr_strong_id.h index 909a1b08d60..5c93cf753a4 100644 --- a/libs/libvtrutil/src/vtr_strong_id.h +++ b/libs/libvtrutil/src/vtr_strong_id.h @@ -72,7 +72,7 @@ * 2. T - the underlying integral id type (default: int) [Optional] * 3. T sentinel - a value representing an invalid Id (default: -1) [Optional] * - * If no value is supllied during construction the StrongId is initialized to the invalid/sentinel value. + * If no value is supplied during construction the StrongId is initialized to the invalid/sentinel value. * * Example 1: default definition * diff --git a/libs/libvtrutil/src/vtr_strong_id_range.h b/libs/libvtrutil/src/vtr_strong_id_range.h index c4cb036ddf4..ab761fdf8a7 100644 --- a/libs/libvtrutil/src/vtr_strong_id_range.h +++ b/libs/libvtrutil/src/vtr_strong_id_range.h @@ -11,7 +11,7 @@ namespace vtr { * * StrongId's are described in vtr_strong_id.h. In some cases, StrongId's be considered * like random access iterators, but not all StrongId's have this property. - * In addition, there is utility in refering to a range of id's, and being able + * In addition, there is utility in referring to a range of id's, and being able * to iterator over that range. */ @@ -151,7 +151,7 @@ inline StrongIdIterator operator-( /** * @brief StrongIdRange class * - * StrongIdRange allows a pair of StrongId's to defines a continguous range of + * StrongIdRange allows a pair of StrongId's to defines a contiguous range of * ids. The "end" StrongId is excluded from this range. */ template @@ -175,7 +175,7 @@ class StrongIdRange { ///@brief Returns true if the range is empty bool empty() { return begin_ == end_; } - ///@brief Reurns the size of the range + ///@brief Returns the size of the range size_t size() { return std::distance(begin(), end()); } diff --git a/libs/libvtrutil/src/vtr_token.h b/libs/libvtrutil/src/vtr_token.h index 1c87c6e37cd..3b828d2e309 100644 --- a/libs/libvtrutil/src/vtr_token.h +++ b/libs/libvtrutil/src/vtr_token.h @@ -43,7 +43,7 @@ class Tokens { std::vector tokens_; }; -/// @brief Returns a 2D array representing the atof result of all the input string entries seperated by whitespace +/// @brief Returns a 2D array representing the atof result of all the input string entries separated by whitespace void my_atof_2D(float** matrix, const int max_i, const int max_j, std::string_view instring); /** diff --git a/libs/libvtrutil/src/vtr_util.h b/libs/libvtrutil/src/vtr_util.h index e5e09900b35..e16ab7fdc53 100644 --- a/libs/libvtrutil/src/vtr_util.h +++ b/libs/libvtrutil/src/vtr_util.h @@ -15,7 +15,7 @@ std::string replace_first(std::string_view input, std::string_view search, std:: ///@brief Returns 'input' with all instances of 'search' replaced with 'replace' std::string replace_all(std::string_view input, std::string_view search, std::string_view replace); -///@brief Retruns true if str starts with prefix +///@brief Returns true if str starts with prefix bool starts_with(const std::string& str, std::string_view prefix); ///@brief Returns a std::string formatted using a printf-style format string @@ -25,7 +25,7 @@ std::string string_fmt(const char* fmt, ...); std::string vstring_fmt(const char* fmt, va_list args); /** - * @brief Joins a sequence by a specified delimeter + * @brief Joins a sequence by a specified delimiter * * For example the sequence {"home", "user", "my_files", "test.blif"} with delim="/" * would return "home/user/my_files/test.blif" @@ -252,7 +252,7 @@ class StringToken { std::vector split(const std::vector& delim) const; std::vector split(); /** - * @brief Find the position (i-th charactor) in a string for a given + * @brief Find the position (i-th character) in a string for a given * delimiter, it will return a list of positions For example, to find the * position of all quotes (") in a string: "we" are good The following code is * suggested: StringToken tokenizer("\"we\" are good"); std::vector @@ -263,10 +263,10 @@ class StringToken { /** * @brief split the string for each chunk. This is useful where there are - * chunks of substring should not be splitted by the given delimiter For + * chunks of substring should not be split by the given delimiter For * example, to split the string with quotes (") in a string: source "cmdA * --opt1 val1;cmdB --opt2 val2" --verbose where the string between the two - * quotes should not be splitted The following code is suggested: StringToken + * quotes should not be split. The following code is suggested: StringToken * tokenizer("source \"cmdA --opt1 val1;cmdB --opt2 val2\" --verbose"); * std::vector tokenizer.split_by_chunks('\"', true); * The following vector will be returned: @@ -303,7 +303,7 @@ class StringToken { void add_default_delim(); private: /* Internal data */ - std::string data_; /* Lines to be splited */ + std::string data_; /* Lines to be split */ std::vector delims_; }; diff --git a/libs/libvtrutil/src/vtr_vec_id_set.h b/libs/libvtrutil/src/vtr_vec_id_set.h index 1b54172a86d..dd22b584ba1 100644 --- a/libs/libvtrutil/src/vtr_vec_id_set.h +++ b/libs/libvtrutil/src/vtr_vec_id_set.h @@ -14,7 +14,7 @@ namespace vtr { * - membership test * all in constant time. * - * It assumes the element type (T) is convertable to size_t. + * It assumes the element type (T) is convertible to size_t. * Usually, elements are vtr::StrongIds. * * Iteration through the elements is not strictly ordered, usually diff --git a/libs/libvtrutil/src/vtr_vector.h b/libs/libvtrutil/src/vtr_vector.h index bcf195c40a4..b32ce5e4d42 100644 --- a/libs/libvtrutil/src/vtr_vector.h +++ b/libs/libvtrutil/src/vtr_vector.h @@ -14,7 +14,7 @@ namespace vtr { * @brief A std::vector container which is indexed by K (instead of size_t). * * The main use of this container is to behave like a std::vector which is - * indexed by a vtr::StrongId. It assumes that K is explicitly convertable to size_t + * indexed by a vtr::StrongId. It assumes that K is explicitly convertible to size_t * (i.e. via operator size_t()), and can be explicitly constructed from a size_t. * * It includes all the following std::vector functions: @@ -198,7 +198,7 @@ class vector : private std::vector { public: /** - * @brief Iterator class which is convertable to the key_type + * @brief Iterator class which is convertible to the key_type * * This allows end-users to call the parent class's keys() member * to iterate through the keys with a range-based for loop @@ -216,7 +216,7 @@ class vector : private std::vector { : value_(init) {} /* - * vtr::vector assumes that the key time is convertable to size_t. + * vtr::vector assumes that the key time is convertible to size_t. * * It also assumes all the underlying IDs are zero-based and contiguous. That means * we can just increment the underlying Id to build the next key. diff --git a/libs/libvtrutil/src/vtr_vector_map.h b/libs/libvtrutil/src/vtr_vector_map.h index 337773ba12a..8651df69d6a 100644 --- a/libs/libvtrutil/src/vtr_vector_map.h +++ b/libs/libvtrutil/src/vtr_vector_map.h @@ -15,7 +15,7 @@ namespace vtr { * The main use of this container is to behave like a std::vector which is indexed by * vtr::StrongId. * - * Requires that K be convertable to size_t with the size_t operator (i.e. size_t()), and + * Requires that K be convertible to size_t with the size_t operator (i.e. size_t()), and * that the conversion results in a linearly increasing index into the underlying vector. * * This results in a container that is somewhat similar to a std::map (i.e. converts from one diff --git a/libs/libvtrutil/src/vtr_version.cpp.in b/libs/libvtrutil/src/vtr_version.cpp.in index 4755874ba94..1099e7f2caf 100644 --- a/libs/libvtrutil/src/vtr_version.cpp.in +++ b/libs/libvtrutil/src/vtr_version.cpp.in @@ -1,7 +1,7 @@ #include "vtr_version.h" //This file is automatically processed by CMAKE and replaces -//the values between ampersand's with the releveant CMAKE variable +//the values between ampersand's with the relevant CMAKE variable //before being compiled. namespace vtr { const char* VERSION = "@VTR_VERSION@"; diff --git a/libs/libvtrutil/test/test_small_vector.cpp b/libs/libvtrutil/test/test_small_vector.cpp index c0c47ab24e4..0516e080499 100644 --- a/libs/libvtrutil/test/test_small_vector.cpp +++ b/libs/libvtrutil/test/test_small_vector.cpp @@ -5,7 +5,7 @@ namespace vtr { -//Must be delcared in namespace for argument dependent lookup to work with clang +//Must be declared in namespace for argument dependent lookup to work with clang template bool operator==(const std::vector& lhs, const vtr::small_vector& rhs) { if (lhs.size() != rhs.size()) return false;