Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Data Array to Store, Speed Optimizations, Code Cleanup (SimplnxCore) #1017

Merged
merged 24 commits into from
Aug 23, 2024

Conversation

nyoungbq
Copy link
Contributor

@nyoungbq nyoungbq commented Jul 12, 2024

Fixes #1047

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file simplnx/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file simplnx/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

@nyoungbq nyoungbq force-pushed the enh/data_array_to_store branch from 44a2c2a to 062d06e Compare July 12, 2024 14:36
@nyoungbq nyoungbq changed the title ENH: Data Array to Store and Speed Optimizations [WIP] ENH: Data Array to Store and Speed Optimizations Jul 12, 2024
@nyoungbq nyoungbq force-pushed the enh/data_array_to_store branch from 062d06e to 16f20af Compare July 16, 2024 10:58
@nyoungbq nyoungbq force-pushed the enh/data_array_to_store branch from 16f20af to 8613142 Compare July 23, 2024 11:50
@imikejackson imikejackson force-pushed the enh/data_array_to_store branch from 8151f08 to 36036f5 Compare July 30, 2024 12:38
@nyoungbq nyoungbq changed the title [WIP] ENH: Data Array to Store and Speed Optimizations [WIP] ENH: Data Array to Store and Speed Optimizations (SimplnxCore) Aug 9, 2024
@nyoungbq nyoungbq force-pushed the enh/data_array_to_store branch 2 times, most recently from 3bca63d to 68095e4 Compare August 9, 2024 18:32
@nyoungbq nyoungbq force-pushed the enh/data_array_to_store branch from 5c4354c to d940056 Compare August 20, 2024 16:56
@nyoungbq nyoungbq marked this pull request as ready for review August 20, 2024 17:36
@nyoungbq nyoungbq changed the title [WIP] ENH: Data Array to Store and Speed Optimizations (SimplnxCore) ENH: Data Array to Store, Speed Optimizations, Code Cleanup (SimplnxCore) Aug 20, 2024
@nyoungbq nyoungbq merged commit 7fb7ffe into BlueQuartzSoftware:develop Aug 23, 2024
7 checks passed
@nyoungbq nyoungbq deleted the enh/data_array_to_store branch August 23, 2024 14:51
imikejackson pushed a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
…lnxCore) (BlueQuartzSoftware#1017)

* extraneous code removal and AbstractDataStore integration for SimplnxCore and main simplnx Utility Files
* moved various free functions to an anonymous namespaces
* bug fix where duplicate nodes were being ignored on STL file read in in the Z dimension
* [1 broken test] All algorithms complete, rework of IDataArray to typed store that avoids extra dynamic cast
* Fix Write Stl bug accidentally introduced
* Utilities updates
* Fix Accidental Boolean Fallthrough
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Read in STL File Files Do Not Extract Duplicate Nodes in the Z Dimension (Known Issue)
3 participants