diff --git a/vpr/scripts/profile/parse_and_plot_detailed.py b/vpr/scripts/profile/parse_and_plot_detailed.py index cfb70670ea2..fff610b2f17 100755 --- a/vpr/scripts/profile/parse_and_plot_detailed.py +++ b/vpr/scripts/profile/parse_and_plot_detailed.py @@ -12,7 +12,7 @@ import csv from datetime import datetime -# generate images wihtout having a window appear +# generate images without having a window appear import matplotlib matplotlib.use("Agg") diff --git a/vpr/src/draw/breakpoint.h b/vpr/src/draw/breakpoint.h index 0b0091826d0..0d41bda165d 100644 --- a/vpr/src/draw/breakpoint.h +++ b/vpr/src/draw/breakpoint.h @@ -6,13 +6,13 @@ * * This file holds the declaration of the breakpoint class, and also some of the breakpoint related functions. * - * This class holds the definiton of type Breakpoint as well as all related functions. + * This class holds the definition of type Breakpoint as well as all related functions. * Breakpoints can be set through the GUI anytime during placement or routing. Breakpoints can also be activated, * deactivated, and deleted. Each breakpoint has a type (BT_MOVE_NUM, BT_TEMP_NUM, BT_FROM_BLOCK, BT_ROUTER_ITER, BT_ROUTE_NET_ID, BT_EXPRESSION) and holds the * values for corresponding to its type, as well as a boolean variable to activate and deactivate a breakpoint. It should be noted that each breakpoint can only have one type and hold one value corresponding to that type. * More complicated breakpoints are set using an expression. (e.g move_num > 3 && block_id == 11) - * Breakpoints can be create using 3 constructors, the default contructor that doesn't identify the type and sets a breakpoint that is never reached, - * a constructor that takes in the type and an int value, and lastly a constructor that takes in the type and the sting that holds the expression. + * Breakpoints can be create using 3 constructors, the default constructor that doesn't identify the type and sets a breakpoint that is never reached, + * a constructor that takes in the type and an int value, and lastly a constructor that takes in the type and the string that holds the expression. * (e.g Breakpoint(BT_MOVE_NUM, 4) or Breakpoint(BT_EXPRESSION, "move_num += 3")) The == operator has also been provided which returns true when two * breakpoints have the same type, and the same value corresponding to the type. */ @@ -69,7 +69,7 @@ class Breakpoint { bt_route_net_id = breakpoint_value; } - //sets the breakpoint type to BT_EXPRESSION and sets the string member bt_expression to the expresssion the user inputted. e.g Breakpoint(BT_EXPRESSION, "move_num==3") + //sets the breakpoint type to BT_EXPRESSION and sets the string member bt_expression to the expression the user inputted. e.g Breakpoint(BT_EXPRESSION, "move_num==3") //the user can set breakpoints, during routing or placement, using an expression with the available variables and operators Breakpoint(bp_type ty, std::string expr) { type = ty; @@ -99,7 +99,7 @@ class Breakpoint { } }; -//breakpoint realted functions to be called from draw.cpp, place.cpp and route_timing.cpp +//breakpoint related functions to be called from draw.cpp, place.cpp and route_timing.cpp //checks for all types of breakpoint and returns true if a breakpoint is encountered bool check_for_breakpoints(bool in_placer); diff --git a/vpr/src/draw/draw.cpp b/vpr/src/draw/draw.cpp index 0dec7e8f1e9..2a8e2b99bb4 100644 --- a/vpr/src/draw/draw.cpp +++ b/vpr/src/draw/draw.cpp @@ -1334,7 +1334,7 @@ ezgl::color get_block_type_color(t_physical_tile_type_ptr type) { return color; } -//Lightens a color's luminance [0, 1] by an aboslute 'amount' +//Lightens a color's luminance [0, 1] by an absolute 'amount' ezgl::color lighten_color(ezgl::color color, float amount) { constexpr double MAX_LUMINANCE = 0.95; //Clip luminance so it doesn't go full white auto hsl = color2hsl(color); diff --git a/vpr/src/draw/draw.h b/vpr/src/draw/draw.h index 326b16d4a23..ef68f0e5ee9 100644 --- a/vpr/src/draw/draw.h +++ b/vpr/src/draw/draw.h @@ -2,7 +2,7 @@ /** * @file draw.h * - * The main drawing file. Contains the setup for ezgl application, ui setup, and graphis functions + * The main drawing file. Contains the setup for ezgl application, ui setup, and graphics functions * * This is VPR's main graphics application program. The program interacts with ezgl/graphics.hpp, * which provides an API for displaying graphics on both X11 and Win32. The most important diff --git a/vpr/src/draw/draw_basic.cpp b/vpr/src/draw/draw_basic.cpp index 3634b846b81..39d76085ea2 100644 --- a/vpr/src/draw/draw_basic.cpp +++ b/vpr/src/draw/draw_basic.cpp @@ -520,13 +520,13 @@ void draw_routing_bb(ezgl::renderer* g) { // //In the graphics we represent this by drawing the BB so that legal RR node start/end points //are contained within the drawn box. Since VPR associates each x/y channel location to - //the right/top of the tile with the same x/y cordinates, this means we draw the box so that: + //the right/top of the tile with the same x/y coordinates, this means we draw the box so that: // * The left edge is to the left of the channel at bb xmin (including the channel at xmin) // * The bottom edge is to the below of the channel at bb ymin (including the channel at ymin) // * The right edge is to the right of the channel at bb xmax (including the channel at xmax) // * The top edge is to the right of the channel at bb ymax (including the channel at ymax) //Since tile_x/tile_y correspond to the drawing coordinates the block at grid x/y's bottom-left corner - //this means we need to shift the top/right drawn co-ordinate one tile + channel width right/up so + //this means we need to shift the top/right drawn coordinate one tile + channel width right/up so //the drawn box contains the top/right channels double draw_xlow = draw_coords->tile_x[bb->xmin]; double draw_ylow = draw_coords->tile_y[bb->ymin]; @@ -617,7 +617,7 @@ void draw_routed_net(ParentNetId net_id, ezgl::renderer* g) { draw_state->draw_rr_node[inode].color = DEFAULT_RR_NODE_COLOR; } - // When drawing a new branch, add the parent node to the vector to ensure that the conenction is drawn. + // When drawing a new branch, add the parent node to the vector to ensure that the connection is drawn. if (rr_nodes_to_draw.empty() && rt_node.parent().has_value()) { rr_nodes_to_draw.push_back(rt_node.parent().value().inode); } diff --git a/vpr/src/draw/draw_basic.h b/vpr/src/draw/draw_basic.h index 580f4d7783a..4ac429bf2b4 100644 --- a/vpr/src/draw/draw_basic.h +++ b/vpr/src/draw/draw_basic.h @@ -127,7 +127,7 @@ void draw_routed_timing_edge_connection(tatum::NodeId src_tnode, ezgl::renderer* g); /* Draws any placement macros (e.g. carry chains, which require specific relative placements - * between some blocks) if the Placement Macros (in the GUI) is seelected. + * between some blocks) if the Placement Macros (in the GUI) is selected. */ void draw_placement_macros(ezgl::renderer* g); diff --git a/vpr/src/draw/draw_color.h b/vpr/src/draw/draw_color.h index a73bacfc5e1..9a9f2158ce6 100644 --- a/vpr/src/draw/draw_color.h +++ b/vpr/src/draw/draw_color.h @@ -165,7 +165,7 @@ static constexpr ezgl::color blk_ALICEBLUE(0xF0, 0xF8, 0xFF); //The colours used to draw block types const std::vector block_colors{ //This first set of colours is somewhat curated to yield - //a nice colour pallette + //a nice colour palette blk_BISQUE, //EMPTY type is usually the type with index 0, so this colour //usually unused blk_LIGHTGREY, diff --git a/vpr/src/draw/draw_debug.cpp b/vpr/src/draw/draw_debug.cpp index 88111319767..cae42711473 100644 --- a/vpr/src/draw/draw_debug.cpp +++ b/vpr/src/draw/draw_debug.cpp @@ -4,7 +4,7 @@ #include "draw_global.h" #include "vtr_expr_eval.h" -//keeps track of open windows to avoid reopenning windows that are alerady open +//keeps track of open windows to avoid reopenning windows that are already open struct open_windows { bool debug_window = false; bool advanced_window = false; @@ -31,7 +31,7 @@ class DrawDebuggerGlobals { } }; -//the global variable that holds all global variables realted to breakpoint graphics +//the global variable that holds all global variables related to breakpoint graphics DrawDebuggerGlobals draw_debug_glob_vars; //draws main debugger window @@ -360,7 +360,7 @@ void refresh_bpList() { gtk_widget_set_halign(checkbox, GTK_ALIGN_END); gtk_widget_set_valign(checkbox, GTK_ALIGN_CENTER); - //button seetings + //button settings GtkWidget* deleteButton = gtk_button_new(); GtkWidget* image = gtk_image_new_from_file("src/draw/trash.png"); gtk_button_set_image((GtkButton*)deleteButton, image); diff --git a/vpr/src/draw/draw_noc.cpp b/vpr/src/draw/draw_noc.cpp index 062e03d078c..815df9f36e0 100644 --- a/vpr/src/draw/draw_noc.cpp +++ b/vpr/src/draw/draw_noc.cpp @@ -36,7 +36,7 @@ void draw_noc(ezgl::renderer* g) { return; } - // check that the NoC tile has a capacity greater than 0 (can we assume it always will?) and if not then we cant draw anything as the NoC tile won't be drawn + // check that the NoC tile has a capacity greater than 0 (can we assume it always will?) and if not then we can't draw anything as the NoC tile won't be drawn /* since the vector of routers all have a reference positions on the grid to the corresponding physical tile, just use the first router in the vector and get its position, then use this to get the capacity of a noc router tile */ const auto& type = device_ctx.grid.get_physical_type({router_list.begin()->get_router_grid_position_x(), @@ -54,7 +54,7 @@ void draw_noc(ezgl::renderer* g) { // Now construct the coordinates for the markers that represent the connections between links (relative to the noc router tile position) ezgl::rectangle noc_connection_marker_bbox = get_noc_connection_marker_bbox(noc_router_logical_type); - // only draw the noc useage if the user selected the option + // only draw the noc usage if the user selected the option if (draw_state->draw_noc == DRAW_NOC_LINK_USAGE) { draw_noc_usage(noc_link_colors); diff --git a/vpr/src/draw/draw_searchbar.h b/vpr/src/draw/draw_searchbar.h index 59582ee529e..687f17737bf 100644 --- a/vpr/src/draw/draw_searchbar.h +++ b/vpr/src/draw/draw_searchbar.h @@ -58,7 +58,7 @@ void draw_highlight_fan_in_fan_out(const std::set& nodes); std::set draw_expand_non_configurable_rr_nodes(RRNodeId hit_node); /* Sets the color of all clbs, nets and rr_nodes to the default. - * as well as clearing the highlighed sub-block */ + * as well as clearing the highlighted sub-block */ void deselect_all(); #endif /* NO_GRAPHICS */ diff --git a/vpr/src/draw/draw_toggle_functions.cpp b/vpr/src/draw/draw_toggle_functions.cpp index 2abdc17c3dc..d6c85adf83e 100644 --- a/vpr/src/draw/draw_toggle_functions.cpp +++ b/vpr/src/draw/draw_toggle_functions.cpp @@ -261,7 +261,7 @@ void toggle_blk_internal_cbk(GtkSpinButton* self, ezgl::application* app) { * @brief cbk function when pin util gets changed in ui; sets pin util drawing to new val * updates draw_state->show_blk_pin_util * - * @param self ptr to selt + * @param self ptr to self * @param app ezgl::app */ void toggle_blk_pin_util_cbk(GtkComboBoxText* self, ezgl::application* app) { @@ -286,7 +286,7 @@ void toggle_blk_pin_util_cbk(GtkComboBoxText* self, ezgl::application* app) { * @brief cbk function when pin util gets changed in ui; sets pin util drawing to new val * updates draw_state->show_placement_macros * - * @param self ptr to selt + * @param self ptr to self * @param app ezgl::app */ void placement_macros_cbk(GtkComboBoxText* self, ezgl::application* app) { diff --git a/vpr/src/draw/intra_logic_block.cpp b/vpr/src/draw/intra_logic_block.cpp index bed9663be7a..17bc571deb1 100644 --- a/vpr/src/draw/intra_logic_block.cpp +++ b/vpr/src/draw/intra_logic_block.cpp @@ -148,7 +148,7 @@ void draw_internal_init_blk() { // and that consequently we have *one* model for each type. bot_left = {0, 0}; if (size_t(width) > device_ctx.grid.width() || size_t(height) > device_ctx.grid.height()) { - // in this case, the clb certainly wont't fit, but this prevents + // in this case, the clb certainly won't fit, but this prevents // an out-of-bounds access, and provides some sort of (probably right) // value top_right = ezgl::point2d( @@ -465,7 +465,7 @@ static void draw_internal_pb(const ClusterBlockId clb_index, t_pb* pb, const ezg } } else { - // else (ie. has chilren, and isn't at the lowest displayed level) + // else (ie. has children, and isn't at the lowest displayed level) // just label its type, and put it up at the top so we can see it if (draw_state->draw_block_text) { g->draw_text( @@ -882,7 +882,7 @@ void t_selected_sub_block_info::set(t_pb* new_selected_sub_block, const ClusterB for (auto blk_id : atom_ctx.netlist().blocks()) { const ClusterBlockId clb = atom_ctx.lookup().atom_clb(blk_id); const t_pb_graph_node* pb_graph_node = atom_ctx.lookup().atom_pb_bimap().atom_pb_graph_node(blk_id); - // find the atom block that corrisponds to this pb. + // find the atom block that corresponds to this pb. if (is_in_selected_subtree(pb_graph_node, clb)) { //Collect the sources of all nets driving this node for (auto pin_id : atom_ctx.netlist().block_input_pins(blk_id)) { diff --git a/vpr/src/draw/intra_logic_block.h b/vpr/src/draw/intra_logic_block.h index 7072cb561bf..997102839da 100644 --- a/vpr/src/draw/intra_logic_block.h +++ b/vpr/src/draw/intra_logic_block.h @@ -127,7 +127,7 @@ void draw_selected_pb_flylines(ezgl::renderer* g); /* * Draws lines from the proper logical sources, to the proper logical sinks. * If the draw state says to show all logical connections, it will, - * and if there is a selected sub-block, it will highlight it's conections + * and if there is a selected sub-block, it will highlight it's connections */ void draw_logical_connections(ezgl::renderer* g); diff --git a/vpr/src/draw/manual_moves.h b/vpr/src/draw/manual_moves.h index 43ab9f3ad6a..1d3dc3156bd 100644 --- a/vpr/src/draw/manual_moves.h +++ b/vpr/src/draw/manual_moves.h @@ -76,7 +76,7 @@ struct ManualMovesState { /** manual moves functions **/ /** - * @brief Gets the state of the manual moves togle button and assigns it to the manual_move_enabled in the ManualMovesState struct. + * @brief Gets the state of the manual moves toggle button and assigns it to the manual_move_enabled in the ManualMovesState struct. * * @return True if the toggle button is active, false otherwise. */ @@ -94,7 +94,7 @@ void draw_manual_moves_window(const std::string& block_id); * @brief Evaluates if the user input is valid and allowed. * * Sets the members from the ManualMovesState manual_moves_state variable to their respective values (block id and locations). - * @param GtkWidget* widget: Passed in for gtk callback functions (Needed due to the GTK function protoype, in GTK documentation). + * @param GtkWidget* widget: Passed in for gtk callback functions (Needed due to the GTK function prototype, in GTK documentation). * @param GtkWidget* grid: The grid is used to extract the user input from the manual move window, to later assign to the ManualMovesState variable. */ void calculate_cost_callback(GtkWidget* /*widget*/, GtkWidget* grid); @@ -102,7 +102,7 @@ void calculate_cost_callback(GtkWidget* /*widget*/, GtkWidget* grid); /** * @brief In -detail checking of the user's input. * - * Checks if the user input is between the grid's dimensions, block comptaibility, if the block requested to move is valid, if the block is fixed, and if the curent location of the block is different from the location requested by the user. + * Checks if the user input is between the grid's dimensions, block comptaibility, if the block requested to move is valid, if the block is fixed, and if the current location of the block is different from the location requested by the user. * @param block_id: The ID of the block to move used as the from block in the move generator). * @param to: Location of where the user wants to move the block. * diff --git a/vpr/src/draw/save_graphics.cpp b/vpr/src/draw/save_graphics.cpp index 657c6626b42..001ecab1e7d 100644 --- a/vpr/src/draw/save_graphics.cpp +++ b/vpr/src/draw/save_graphics.cpp @@ -116,7 +116,7 @@ void save_graphics_dialog_box(GtkWidget* /*widget*/, ezgl::application* /*app*/) // set default values gtk_combo_box_set_active((GtkComboBox*)combo_box, 0); // default set to pdf which has an index 0 - gtk_entry_set_text((GtkEntry*)text_entry, "vpr_graphics"); // defualt text set to vpr_graphics + gtk_entry_set_text((GtkEntry*)text_entry, "vpr_graphics"); // default text set to vpr_graphics // attach elements to the content area of the dialog content_area = gtk_dialog_get_content_area(GTK_DIALOG(dialog)); diff --git a/vpr/src/draw/search_bar.cpp b/vpr/src/draw/search_bar.cpp index e3c9586f072..1a20fb7c9cc 100644 --- a/vpr/src/draw/search_bar.cpp +++ b/vpr/src/draw/search_bar.cpp @@ -495,7 +495,7 @@ GdkEvent simulate_keypress(char key, GdkWindow* window) { /** * @brief Turns on autocomplete * - * This function enables the auto-complete fuctionality for the search bar. + * This function enables the auto-complete functionality for the search bar. * Normally, this is pretty simple, but the idea is to have auto-complete appear as soon * as the user hits the "Enter" key. To accomplish this, a fake Gdk event is created * to simulate the user hitting a key. @@ -514,7 +514,7 @@ GdkEvent simulate_keypress(char key, GdkWindow* window) { * BLOCKS 1835 * BLOCK SRCH. 21840 * For second model (much larger, much longer CPU times) observed large dropoff in times from one char to two chars (about 2 times faster) but after stayed consistent - * Maybe when I ahve more time, will make a cute graph or something, no time right now + * Maybe when I have more time, will make a cute graph or something, no time right now * MODEL 2: Strativix arch + MES_NOC (TITAN) * NETS 577696 * NET SRCH. 4.93438e+06 diff --git a/vpr/src/draw/ui_setup.cpp b/vpr/src/draw/ui_setup.cpp index 9d37ae3eaf6..534f65d02d8 100644 --- a/vpr/src/draw/ui_setup.cpp +++ b/vpr/src/draw/ui_setup.cpp @@ -42,7 +42,7 @@ void basic_button_setup(ezgl::application* app) { gtk_button_set_label(search, "Search"); g_signal_connect(search, "clicked", G_CALLBACK(search_and_highlight), app); - //button for save graphcis, created in main.ui + //button for save graphics, created in main.ui GtkButton* save = (GtkButton*)app->get_object("SaveGraphics"); g_signal_connect(save, "clicked", G_CALLBACK(save_graphics_dialog_box), app); diff --git a/vpr/src/place/initial_placement.cpp b/vpr/src/place/initial_placement.cpp index 0bacfcac783..c5bd91cc6f2 100644 --- a/vpr/src/place/initial_placement.cpp +++ b/vpr/src/place/initial_placement.cpp @@ -1711,7 +1711,7 @@ static inline std::vector get_sorted_clusters_to_place( // Normalize the macro size to be a number between 0 and 1. float normalized_macro_size = macro_size / static_cast(max_macro_size); - // Compute the cost. Clusters wth a higher cost will be placed first. + // Compute the cost. Clusters with a higher cost will be placed first. // Cost is proportional to macro size since larger macros are more // challenging to place and should be placed earlier if possible. // Cost is inversly proportional to standard deviation, since clusters @@ -1723,7 +1723,7 @@ static inline std::vector get_sorted_clusters_to_place( // If the cluster is constrained, compute how much area its constrained // region takes up. This will be used to place "more constrained" blocks // first. - // TODO: The cluster constrained area can be incorperated into the cost + // TODO: The cluster constrained area can be incorporated into the cost // somehow. ClusterBlockId macro_head_blk = pl_macro.members[0].blk_index; if (is_cluster_constrained(macro_head_blk)) { @@ -1838,7 +1838,7 @@ static inline bool place_blocks_min_displacement(std::vector& cl } // The find_nearest_compatible_loc function above should only return - // a location which can legally accomodate the macro (if it found a + // a location which can legally accommodate the macro (if it found a // location). Double check these to be safe. VTR_ASSERT_SAFE(!blk_loc_registry.grid_blocks().block_at_location(centroid_loc)); VTR_ASSERT_SAFE(macro_can_be_placed(pl_macro, centroid_loc, false, blk_loc_registry)); diff --git a/vpr/src/place/initial_placement.h b/vpr/src/place/initial_placement.h index 0a66f0694d8..fcef28add3f 100644 --- a/vpr/src/place/initial_placement.h +++ b/vpr/src/place/initial_placement.h @@ -52,7 +52,7 @@ struct t_grid_empty_locs_block_type { t_pl_loc first_avail_loc; /* * Number of consecutive y-locations starting (and including) from first_avail_loc - * that can accomadate blocks of the type at first_avail_loc. + * that can accommodate blocks of the type at first_avail_loc. */ int num_of_empty_locs_in_y_axis; }; diff --git a/vpr/src/place/move_generators/median_move_generator.cpp b/vpr/src/place/move_generators/median_move_generator.cpp index 56a75287462..73ef2303393 100644 --- a/vpr/src/place/move_generators/median_move_generator.cpp +++ b/vpr/src/place/move_generators/median_move_generator.cpp @@ -304,7 +304,7 @@ bool MedianMoveGenerator::get_bb_incrementally(ClusterNetId net_id, } else { bb_coord_new.xmax = curr_bb_coord.xmax; } - } else { /* Move to left, old postion was not at xmax. */ + } else { /* Move to left, old position was not at xmax. */ bb_coord_new.xmax = curr_bb_coord.xmax; } @@ -360,7 +360,7 @@ bool MedianMoveGenerator::get_bb_incrementally(ClusterNetId net_id, } else { bb_coord_new.ymax = curr_bb_coord.ymax; } - } else { /* Move down, old postion was not at ymax. */ + } else { /* Move down, old position was not at ymax. */ bb_coord_new.ymax = curr_bb_coord.ymax; } diff --git a/vpr/src/place/move_generators/median_move_generator.h b/vpr/src/place/move_generators/median_move_generator.h index 62326cbe145..12c362ac8b3 100644 --- a/vpr/src/place/move_generators/median_move_generator.h +++ b/vpr/src/place/move_generators/median_move_generator.h @@ -12,7 +12,7 @@ class PlaceMacros; * of positions that minimize the HPWL. * * To calculate the median region, we iterate over all the moving block pins calculating the bounding box of each of this nets. - * Then, we push the corrdinates of these bb into two vectors and calculate its median. + * Then, we push the coordinates of these bb into two vectors and calculate its median. * * To get the exact location, we calculate the center of median region and find a random location in a range * around it diff --git a/vpr/src/place/move_generators/simpleRL_move_generator.cpp b/vpr/src/place/move_generators/simpleRL_move_generator.cpp index 9a37af7a73a..c852d392bee 100644 --- a/vpr/src/place/move_generators/simpleRL_move_generator.cpp +++ b/vpr/src/place/move_generators/simpleRL_move_generator.cpp @@ -228,7 +228,7 @@ t_propose_action EpsilonGreedyAgent::propose_action() { /* Explore * With probability epsilon, choose randomly amongst all move types */ - // Cummulative epsilon action probabilty stores a CDF for all available + // Cumulative epsilon action probability stores a CDF for all available // actions where each action has an equal probability to occur. Pick // a random number between 0 and 1 and select the action in the CDF equal // to or just less than the random number. diff --git a/vpr/src/place/move_utils.cpp b/vpr/src/place/move_utils.cpp index ac665e8ef8f..d122597a798 100644 --- a/vpr/src/place/move_utils.cpp +++ b/vpr/src/place/move_utils.cpp @@ -251,7 +251,7 @@ e_block_move_result record_macro_macro_swaps(t_pl_blocks_to_be_moved& blocks_aff // //This function is only called when both the main swap's from/to blocks are placement macros. //The position in the from macro ('imacro_from') is specified by 'imember_from', and the relevant - //macro fro the to block is 'imacro_to'. + //macro for the to block is 'imacro_to'. const auto& block_locs = blk_loc_registry.block_locs(); @@ -272,7 +272,7 @@ e_block_move_result record_macro_macro_swaps(t_pl_blocks_to_be_moved& blocks_aff return outcome; } - //From/To blocks should be exactly the swap offset appart + //From/To blocks should be exactly the swap offset apart ClusterBlockId blk_from = pl_macros[imacro_from].members[imember_from].blk_index; VTR_ASSERT_SAFE(block_locs[blk_from].loc + swap_offset == block_locs[blk_to].loc); @@ -661,7 +661,7 @@ bool find_to_loc_uniform(t_logical_block_type_ptr type, //Note that the range limit (rlim) is applied in a logical sense (i.e. 'compressed' grid space consisting //of the same block types, and not the physical grid space). This means, for example, that columns of 'rare' //blocks (e.g. DSPs/RAMs) which are physically far apart but logically adjacent will be swappable even - //at an rlim fo 1. + //at an rlim of 1. // //This ensures that such blocks don't get locked down too early during placement (as would be the //case with a physical distance rlim) diff --git a/vpr/src/place/move_utils.h b/vpr/src/place/move_utils.h index 77abcef74c6..7f75dc3cc4e 100644 --- a/vpr/src/place/move_utils.h +++ b/vpr/src/place/move_utils.h @@ -234,7 +234,7 @@ bool find_to_loc_uniform(t_logical_block_type_ptr type, bool placer_breakpoint_reached(); // setter for f_placer_breakpoint_reached -// Should be setted in the breakpoint calculation algorithm +// Should be set in the breakpoint calculation algorithm void set_placer_breakpoint_reached(bool); /** diff --git a/vpr/src/place/net_cost_handler.h b/vpr/src/place/net_cost_handler.h index f71509713fb..a87abd108fc 100644 --- a/vpr/src/place/net_cost_handler.h +++ b/vpr/src/place/net_cost_handler.h @@ -304,7 +304,7 @@ class NetCostHandler { /** * @brief Allocates and loads acc_tile_num_inter_die_conn_ which contains the accumulative number of inter-die - * conntections. + * connections. * * @details This is only useful for multi-die FPGAs. */ diff --git a/vpr/src/place/noc_place_checkpoint.h b/vpr/src/place/noc_place_checkpoint.h index 59db6a70e20..b1f739265ed 100644 --- a/vpr/src/place/noc_place_checkpoint.h +++ b/vpr/src/place/noc_place_checkpoint.h @@ -43,7 +43,7 @@ class NoCPlacementCheckpoint { void save_checkpoint(double cost, const vtr::vector_map& block_locs); /** - * @brief Loads the save checkpoint into global placement data structues. + * @brief Loads the save checkpoint into global placement data structures. * * @param costs Used to load NoC related costs for the checkpoint * @param blk_loc_registry To be updated with the save checkpoint for NoC router locations. diff --git a/vpr/src/place/noc_place_utils.h b/vpr/src/place/noc_place_utils.h index 2e833e86b2c..0f827ed3cb1 100644 --- a/vpr/src/place/noc_place_utils.h +++ b/vpr/src/place/noc_place_utils.h @@ -398,7 +398,7 @@ class NocCostHandler { * bandwidth of the traffic flow. If the traffic flow route is being deleted, * then the link bandwidth needs to be decremented. If the traffic flow * route has just been added then the link bandwidth needs to be incremented. - * This function needs to be called everytime a traffic flow has been newly + * This function needs to be called every time a traffic flow has been newly * routed. * * @param traffic_flow_route The routed path for a traffic flow. This diff --git a/vpr/src/place/place.cpp b/vpr/src/place/place.cpp index 91777f45761..8a60e7b3bb9 100644 --- a/vpr/src/place/place.cpp +++ b/vpr/src/place/place.cpp @@ -154,7 +154,7 @@ static void update_screen_debug(); //Performs a major (i.e. interactive) placement screen update. //This function with no arguments is useful for calling from a debugger to -//look at the intermediate implemetnation state. +//look at the intermediate implementation state. static void update_screen_debug() { update_screen(ScreenUpdatePriority::MAJOR, "DEBUG", e_pic_type::PLACEMENT, nullptr); } diff --git a/vpr/src/place/place_util.cpp b/vpr/src/place/place_util.cpp index e09ea27d99b..1818c7790c0 100644 --- a/vpr/src/place/place_util.cpp +++ b/vpr/src/place/place_util.cpp @@ -215,7 +215,7 @@ bool macro_can_be_placed(const t_pl_macro& pl_macro, // Can still accommodate blocks here, check the next position continue; } else { - // Cant be placed here - skip to the next try + // Can't be placed here - skip to the next try mac_can_be_placed = false; break; } diff --git a/vpr/src/place/timing/place_timing_update.cpp b/vpr/src/place/timing/place_timing_update.cpp index 9be5072d697..4ec3f104290 100644 --- a/vpr/src/place/timing/place_timing_update.cpp +++ b/vpr/src/place/timing/place_timing_update.cpp @@ -248,7 +248,7 @@ bool verify_connection_setup_slacks(const PlacerSetupSlacks* setup_slacks, * * In particular, we can not simply calculate the incremental delta's caused by changed * connection timing costs and adjust the timing cost. Due to limited precision, the results - * of floating point math operations are order dependant and we would get a different result. + * of floating point math operations are order dependent and we would get a different result. * * To get around this, we calculate the timing costs hierarchically, to ensure that we * calculate the sum with the same order of operations as comp_td_costs(). diff --git a/vpr/src/place/verify_placement.h b/vpr/src/place/verify_placement.h index 75b2c3f3af6..fa7a93c16ef 100644 --- a/vpr/src/place/verify_placement.h +++ b/vpr/src/place/verify_placement.h @@ -7,7 +7,7 @@ * given placement is valid and can be used with the rest of the VPR * flow. * - * This methods were orginally part of methods found in the place.cpp file and + * This methods were originally part of methods found in the place.cpp file and * the place_constraints.cpp files. Moved into here to put it all in one place. * Since these methods should be completely independent of the place flow, it * makes sense that they are in their own file. diff --git a/vpr/src/timing/read_sdc.cpp b/vpr/src/timing/read_sdc.cpp index 02718390946..1224ff5c7b3 100644 --- a/vpr/src/timing/read_sdc.cpp +++ b/vpr/src/timing/read_sdc.cpp @@ -664,7 +664,7 @@ class SdcParseCallback : public sdcparse::Callback { tc_.clock_domain_name(capture_domain).c_str()); } - //Override the constarint + //Override the constraint setup_constraint = override_setup_constraint; } @@ -720,7 +720,7 @@ class SdcParseCallback : public sdcparse::Callback { tc_.clock_domain_name(capture_domain).c_str()); } - //Override the constarint + //Override the constraint hold_constraint = override_hold_constraint; } @@ -729,7 +729,7 @@ class SdcParseCallback : public sdcparse::Callback { return tatum::Time(hold_constraint); } - //Determine the minumum time (in SDC units) between the edges of the launch and capture clocks + //Determine the minimum time (in SDC units) between the edges of the launch and capture clocks float calculate_min_launch_to_capture_edge_time(tatum::DomainId launch_domain, tatum::DomainId capture_domain) const { constexpr int CLOCK_SCALE = 1000; @@ -794,12 +794,12 @@ class SdcParseCallback : public sdcparse::Callback { //Compare every edge in source_edges with every edge in sink_edges. //The lowest STRICTLY POSITIVE difference between a sink edge and a - //source edge yeilds the setup time constraint. + //source edge yields the setup time constraint. int scaled_constraint = std::numeric_limits::max(); //Initialize to +inf, so any constraint will be less for (int launch_edge : launch_edges) { for (int capture_edge : capture_edges) { - if (capture_edge >= launch_edge) { //Postive only + if (capture_edge >= launch_edge) { //Positive only int edge_diff = capture_edge - launch_edge; VTR_ASSERT(edge_diff >= 0.); @@ -1148,7 +1148,7 @@ void apply_combinational_default_timing_constraints(const AtomNetlist& netlist, std::string clock_name = "virtual_io_clock"; VTR_LOG("Setting default timing constraints:\n"); - VTR_LOG(" * constrain all primay inputs and primary outputs on a virtual external clock '%s'\n", clock_name.c_str()); + VTR_LOG(" * constrain all primary inputs and primary outputs on a virtual external clock '%s'\n", clock_name.c_str()); VTR_LOG(" * optimize virtual clock to run as fast as possible\n"); //Create a virtual clock, with 0 period @@ -1172,7 +1172,7 @@ void apply_single_clock_default_timing_constraints(const AtomNetlist& netlist, std::string clock_name = netlist.net_name(clock_net); VTR_LOG("Setting default timing constraints:\n"); - VTR_LOG(" * constrain all primay inputs and primary outputs on netlist clock '%s'\n", clock_name.c_str()); + VTR_LOG(" * constrain all primary inputs and primary outputs on netlist clock '%s'\n", clock_name.c_str()); VTR_LOG(" * optimize netlist clock to run as fast as possible\n"); //Create the netlist clock with period 0 @@ -1200,7 +1200,7 @@ void apply_multi_clock_default_timing_constraints(const AtomNetlist& netlist, tatum::TimingConstraints& tc) { std::string virtual_clock_name = "virtual_io_clock"; VTR_LOG("Setting default timing constraints:\n"); - VTR_LOG(" * constrain all primay inputs and primary outputs on a virtual external clock '%s'\n", virtual_clock_name.c_str()); + VTR_LOG(" * constrain all primary inputs and primary outputs on a virtual external clock '%s'\n", virtual_clock_name.c_str()); VTR_LOG(" * optimize all netlist and virtual clocks to run as fast as possible\n"); VTR_LOG(" * ignore cross netlist clock domain timing paths\n"); @@ -1254,7 +1254,7 @@ void mark_constant_generators(const AtomNetlist& netlist, } } -//Constrain all primary inputs and primary outputs to the specifed clock domains and delays +//Constrain all primary inputs and primary outputs to the specified clock domains and delays void constrain_all_ios(const AtomNetlist& netlist, const AtomLookup& lookup, tatum::TimingConstraints& tc, @@ -1326,7 +1326,7 @@ std::regex glob_pattern_to_regex(const std::string& glob_pattern) { // '*' is a wildcard match of zero or more instances of any characters // //In regex: - // '*' matches zero or more of the preceeding character + // '*' matches zero or more of the preceding character // '.' matches any character // //To convert a glob to a regex we need to: diff --git a/vpr/src/timing/slack_evaluation.cpp b/vpr/src/timing/slack_evaluation.cpp index 7d14d50c201..241719cf08b 100644 --- a/vpr/src/timing/slack_evaluation.cpp +++ b/vpr/src/timing/slack_evaluation.cpp @@ -214,7 +214,7 @@ bool SetupSlackCrit::incr_update_max_req_and_worst_slack(const tatum::TimingGrap * number the incremental update can be more efficient. * * This is essentially the same calculation as recompute_max_req_and_worst_slack() (which iterates - * over *all* primary). By interating only over the modified nodes, this will produce the correct + * over *all* primary). By interacting only over the modified nodes, this will produce the correct * result *except* when the previous max-required/worst-slack have changed. * * In such as case, if the previously dominant node has had it's required time decreased (or worst diff --git a/vpr/src/timing/timing_graph_builder.cpp b/vpr/src/timing/timing_graph_builder.cpp index 1e183c81289..90bad3f118f 100644 --- a/vpr/src/timing/timing_graph_builder.cpp +++ b/vpr/src/timing/timing_graph_builder.cpp @@ -6,11 +6,11 @@ * * The Timing Graph is a directed acyclic graph (DAG) consisting of nodes and edges: * - Nodes: represent netlist pins (tatum::IPIN, tatum::OPIN) and logical sources/ - * sinks like primary inputs/outpus, flip-flops and clock generators (tatum::SOURCE, + * sinks like primary inputs/outputs, flip-flops and clock generators (tatum::SOURCE, * tatum::SINK). * * Note that tatum::SOURCE/tatum::SINK represent the start/end of - * a timing path. As a result tatum::SOURCE's hould never have input edges (except + * a timing path. As a result tatum::SOURCE's should never have input edges (except * perhaps from a tatum::CPIN if it is a sequential source), and tatum::SINKS's * should never have output edges. * @@ -35,7 +35,7 @@ * sequential elements 'A' and 'B' (controlled by the primitive input * pin 'clk'), and two clouds of combinational logic 'C' and 'D'. * - * The combinational logic 'D' is driven by primtive input 'e' and + * The combinational logic 'D' is driven by primitive input 'e' and * drives primitive output pin 'g'. * * The combinational logic 'C' is driven by the sequential element 'A' and @@ -67,8 +67,8 @@ * * As a result there are the following "timing sub-paths" within this primitive: * - * 1) 'e' -> 'D' -> 'g' (combinational propogation delay) - * 2) 'e' -> 'C' -> 'B' (combinational propogation delay + sequentialsetup/hold check) + * 1) 'e' -> 'D' -> 'g' (combinational propagation delay) + * 2) 'e' -> 'C' -> 'B' (combinational propagation delay + sequentialsetup/hold check) * 3) 'f' -> 'A' (sequential setup/hold check) * 4) 'A' -> 'C' -> 'D' -> 'g' (sequential clock-to-q + combinational propogataion delay) * 5) 'B' -> 'h' (sequential clock-to-q) @@ -77,7 +77,7 @@ * * and one fully contained timing path: * - * 8) 'A' -> 'C' -> 'B' (clock-to-q + combinational propogation delay + * 8) 'A' -> 'C' -> 'B' (clock-to-q + combinational propagation delay * + sequential setup/hold check) * * which all must be modelled by the timing graph: @@ -155,15 +155,15 @@ * Building the Timing Graph From VPR's Data Structures * ---------------------------------------------------- * - * VPR does not directly model the intenals of netlist primitives (e.g. internal + * VPR does not directly model the internals of netlist primitives (e.g. internal * sequential elements like 'A' or 'B' above). Instead, various attributes are * tagged on the pins of the primitive which indicate: * - whether a pin is sequential, combinational or a clock * - whether the pin is combinationally connected to another pin * within the primitive. * - * Mostly there is a one-to-one correspondance between netlist pins and tnodes, - * the only exception is for sequential-sequential connections within a primtive + * Mostly there is a one-to-one correspondence between netlist pins and tnodes, + * the only exception is for sequential-sequential connections within a primitive * (e.g. the fully internal 'A' to 'B' timing path above). * * As a result we make a distinction between tnodes which are strictly "internal" diff --git a/vpr/test/test_ap_primitive_vector.cpp b/vpr/test/test_ap_primitive_vector.cpp index 074ba627b8d..4bc3099c243 100644 --- a/vpr/test/test_ap_primitive_vector.cpp +++ b/vpr/test/test_ap_primitive_vector.cpp @@ -131,7 +131,7 @@ TEST_CASE("test_ap_primitive_vector_verify", "[vpr_ap]") { REQUIRE(vec1.get_dim_val(dim_1) == 2.f); REQUIRE(vec1.get_dim_val(dim_2) == 4.f); } - SECTION("Test comparitors") { + SECTION("Test comparators") { PrimitiveVector vec1, vec2; // empty vector. vec2.set_dim_val(dim_0, 10.f); @@ -213,7 +213,7 @@ TEST_CASE("test_ap_primitive_vector_verify", "[vpr_ap]") { REQUIRE(vec1.is_non_negative()); vec1.set_dim_val(dim_0, 0.f); REQUIRE(vec1.is_non_negative()); - // Postive vector is non-negative + // Positive vector is non-negative vec1.set_dim_val(dim_0, 1.f); REQUIRE(vec1.is_non_negative()); vec1.set_dim_val(dim_1, 2.f); diff --git a/vpr/test/test_clustered_netlist.cpp b/vpr/test/test_clustered_netlist.cpp index c7d5e54214b..1eea06c95ee 100644 --- a/vpr/test/test_clustered_netlist.cpp +++ b/vpr/test/test_clustered_netlist.cpp @@ -65,7 +65,7 @@ TEST_CASE("test_find_block_with_matching_name", "[vpr_clustered_netlist]") { noc_router_logical_type_clusters.push_back(block_id_from_name.find(router_four)->second); // now find a block just knowing its instance name - // the test names will have an arbritary number of characters in front and then the name of the instance and then maybe some characters after + // the test names will have an arbitrary number of characters in front and then the name of the instance and then maybe some characters after std::string test_router_module_name = "(.*)(noc_router_one)(.*)"; //get the block id @@ -96,7 +96,7 @@ TEST_CASE("test_find_block_with_matching_name", "[vpr_clustered_netlist]") { noc_router_logical_type_clusters.push_back(block_id_from_name.find(router_four)->second); // now find a block just knowing its unique identifier - // the test names will have an arbritary number of characters in front of them and the unique identifier at the end + // the test names will have an arbitrary number of characters in front of them and the unique identifier at the end std::string test_router_module_name = "(.*)(q_a\\[2\\])(.*)"; //get the block id @@ -117,7 +117,7 @@ TEST_CASE("test_find_block_with_matching_name", "[vpr_clustered_netlist]") { // add the routers and the IO block - // add the IO block with a similiar name + // add the IO block with a similar name block_id_from_name.emplace(i_o_block_with_same_name, test_netlist.create_block(i_o_block_with_same_name, &i_o_pb, i_o_ref)); // add routers diff --git a/vpr/test/test_noc_storage.cpp b/vpr/test/test_noc_storage.cpp index 225614a43a2..07a04033a68 100644 --- a/vpr/test/test_noc_storage.cpp +++ b/vpr/test/test_noc_storage.cpp @@ -49,7 +49,7 @@ TEST_CASE("test_adding_routers_to_noc_storage", "[vpr_noc]") { // add router to the golden vector golden_set.emplace_back(router_number, router_grid_position_x, router_grid_position_y, 0, DUMMY_LATENCY); - // add tje router to the noc + // add the router to the noc test_noc.add_router(curr_router_id, router_grid_position_x, router_grid_position_y, 0, DUMMY_LATENCY); } @@ -101,7 +101,7 @@ TEST_CASE("test_router_id_conversion", "[vpr_noc]") { // add router to the golden vector golden_set.emplace_back(router_number, router_grid_position_x, router_grid_position_y, 0, DUMMY_LATENCY); - // add tje router to the noc + // add the router to the noc test_noc.add_router(curr_router_id, router_grid_position_x, router_grid_position_y, 0, DUMMY_LATENCY); } @@ -149,7 +149,7 @@ TEST_CASE("test_add_link", "[vpr_noc]") { // determine the current router parameters router_id = router_number; - // add tje router to the noc + // add the router to the noc test_noc.add_router(router_id, curr_router_x_pos, curr_router_y_pos, @@ -238,7 +238,7 @@ TEST_CASE("test_router_link_list", "[vpr_noc]") { // determine the current router parameters router_id = router_number; - // add tje router to the noc + // add the router to the noc test_noc.add_router(router_id, curr_router_x_pos, curr_router_y_pos, 0, DUMMY_LATENCY); } @@ -312,7 +312,7 @@ TEST_CASE("test_remove_link", "[vpr_noc]") { // determine the current router parameters router_id = router_number; - // add tje router to the noc + // add the router to the noc test_noc.add_router(router_id, curr_router_x_pos, curr_router_y_pos, diff --git a/vpr/test/test_read_xml_noc_traffic_flows_file.cpp b/vpr/test/test_read_xml_noc_traffic_flows_file.cpp index 43986cd9144..153f74e96b7 100644 --- a/vpr/test/test_read_xml_noc_traffic_flows_file.cpp +++ b/vpr/test/test_read_xml_noc_traffic_flows_file.cpp @@ -9,7 +9,7 @@ namespace { /* * Delete all the blocks in the global clustered netlist. * Then create an empty clustered netlist and assign it - * to the globabl clustered netlist. + * to the global clustered netlist. */ void free_clustered_netlist(void) { auto& cluster_ctx = g_vpr_ctx.mutable_clustering(); @@ -142,7 +142,7 @@ TEST_CASE("test_get_router_module_cluster_id", "[vpr_noc_traffic_flows_parser]") router_block_2.name = router_2; t_logical_block_type_ptr router_ref_2 = &router_block_2; - // add these two logical tyes as the equivalent sites of the subtile + // add these two logical types as the equivalent sites of the subtile router_tile.equivalent_sites.push_back(router_ref); router_tile.equivalent_sites.push_back(router_ref_2); @@ -284,7 +284,7 @@ TEST_CASE("test_check_traffic_flow_router_module_type", "[vpr_noc_traffic_flows_ router_block.name = router; t_logical_block_type_ptr router_ref = &router_block; - // add the logical tyes as the equivalent sites of the subtile + // add the logical types as the equivalent sites of the subtile router_tile.equivalent_sites.push_back(router_ref); // add the subtile to the physical noc router type @@ -322,11 +322,11 @@ TEST_CASE("test_check_traffic_flow_router_module_type", "[vpr_noc_traffic_flows_ // create a name for a IO block char io_block_one[] = "io_block_one"; - // create a cluster blcok that represents a IO block + // create a cluster block that represents a IO block ClusterBlockId io_module_id = test_netlist->create_block(io_block_one, nullptr, i_o_ref); - // now run the test function to verify that the current IO module doesnt have a logical type of a router - // the function should faile since the module is of type IO + // now run the test function to verify that the current IO module doesn't have a logical type of a router + // the function should fail since the module is of type IO REQUIRE_THROWS_WITH(check_traffic_flow_router_module_type(io_block_one, io_module_id, test, test_location, cluster_ctx, noc_router_ref), "The supplied module name 'io_block_one' is not a NoC router."); // clear the global netlist data structure so other unit tests that rely on dont use a corrupted netlist @@ -371,7 +371,7 @@ TEST_CASE("test_check_that_all_router_blocks_have_an_associated_traffic_flow", " // create a single subtile t_sub_tile router_tile; - // add the logical tyes as the equivalent sites of the subtile + // add the logical types as the equivalent sites of the subtile router_tile.equivalent_sites.push_back(router_ref); // add the subtile to the physical noc router type @@ -382,7 +382,7 @@ TEST_CASE("test_check_that_all_router_blocks_have_an_associated_traffic_flow", " // need to add the physical type of the router to the list of physical tiles that match to the router logical block router_block.equivalent_tiles.push_back(noc_router_ref); - // define arbritary values for traffic flow bandwidths, latency and priority + // define arbitrary values for traffic flow bandwidths, latency and priority double traffic_flow_bandwidth = 0.0; double traffic_flow_latency = 0.0; int traffic_flow_priority = 1; @@ -463,7 +463,7 @@ TEST_CASE("test_get_cluster_blocks_compatible_with_noc_router_tiles", "[vpr_noc_ // need to add the physical type of the router to the list of physical tiles that match to the router logical block router_block.equivalent_tiles.push_back(noc_router_ref); - // create a second tupe of router logical block + // create a second type of router logical block t_logical_block_type router_block_type_two; char router_two_name[] = "router_2"; router_block_type_two.name = router_two_name; diff --git a/vpr/test/test_setup_noc.cpp b/vpr/test/test_setup_noc.cpp index e0c4a48e0e1..66f97db77a6 100644 --- a/vpr/test/test_setup_noc.cpp +++ b/vpr/test/test_setup_noc.cpp @@ -45,7 +45,7 @@ TEST_CASE("test_identify_and_store_noc_router_tile_positions", "[vpr_setup_noc]" // make sure the test result is not corrupted REQUIRE(list_of_routers.empty()); - SECTION("All routers are seperated by one or more grid spaces") { + SECTION("All routers are separated by one or more grid spaces") { // in this test, the routers will be on the 4 corners of the FPGA // bottom left corner @@ -442,7 +442,7 @@ TEST_CASE("test_create_noc_routers", "[vpr_setup_noc]") { const vtr::vector* noc_routers = nullptr; - SECTION("Test create routers when logical routers match to exactly one physical router. The number of routers is less than whats on the FPGA.") { + SECTION("Test create routers when logical routers match to exactly one physical router. The number of routers is less than what's on the FPGA.") { // start by creating all the logical routers // this is similar to the user provided a config file temp_router = new t_router; @@ -472,7 +472,7 @@ TEST_CASE("test_create_noc_routers", "[vpr_setup_noc]") { // now we got through the noc model and confirm that the correct for (int router_id = 1; router_id < 7; router_id++) { - // covert the router id + // convert the router id noc_router_id = noc_model.convert_router_id(router_id); // get the router that we are testing from the NoC @@ -515,7 +515,7 @@ TEST_CASE("test_create_noc_routers", "[vpr_setup_noc]") { // now we got through the noc model and confirm that the correct for (int router_id = 1; router_id < 10; router_id++) { - // covert the router id + // convert the router id noc_router_id = noc_model.convert_router_id(router_id); // get the router that we are testing now from the NoC