Skip to content
This repository has been archived by the owner on Oct 23, 2022. It is now read-only.

Add functions to access cluster basis to lattices (fixes #298) #299

Merged
merged 3 commits into from
Oct 15, 2021

Conversation

BrianGun
Copy link
Contributor

@BrianGun BrianGun commented Oct 14, 2021

Pull Request Template

Description

No functions to access clusterbasis in lattic clusters. This adds those functions. Also basis function and clusterbasis function had different meaning. basis returned the basis matrix and clusterbasis returned the LatticeBasis object. Renamed basis to basismatrix to make it consistent.

Fixes # (298)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • [x ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

added test to access cluster basis and ensure it is correct

Test Configuration(s):

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

  • [x ] My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • [x ] I have commented my code, particularly in hard-to-understand areas
  • [x ] I have made corresponding changes to the documentation
  • [x ] My changes generate no new warnings
  • [x ] I have added tests that prove my fix is effective or that my feature works
  • [ x] New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • [ x] I have checked my code and corrected any misspellings

@BrianGun BrianGun requested review from friggog and galran October 14, 2021 22:09
@BrianGun BrianGun changed the title Add functions to access cluster basis to lattices (fixes Add functions to access cluster basis to lattices (fixes #298) Oct 14, 2021
@codecov-commenter
Copy link

codecov-commenter commented Oct 14, 2021

Codecov Report

Merging #299 (bd942b3) into main (fb1e92d) will decrease coverage by 0.01%.
The diff coverage is 71.42%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #299      +/-   ##
==========================================
- Coverage   54.54%   54.53%   -0.02%     
==========================================
  Files          78       78              
  Lines        7394     7073     -321     
==========================================
- Hits         4033     3857     -176     
+ Misses       3361     3216     -145     
Impacted Files Coverage Δ
src/RepeatingStructures/RectangularLattice.jl 20.00% <0.00%> (ø)
src/RepeatingStructures/HexagonalLattice.jl 46.47% <50.00%> (-4.18%) ⬇️
src/RepeatingStructures/Cluster.jl 55.17% <100.00%> (+3.44%) ⬆️
src/RepeatingStructures/Lattice.jl 71.42% <100.00%> (-9.83%) ⬇️
src/Optical/OpticalInterface.jl 64.28% <0.00%> (-2.39%) ⬇️
src/Geometry/Primitives/Curves/BSpline.jl 66.15% <0.00%> (-2.13%) ⬇️
src/Optical/Paraxial.jl 69.56% <0.00%> (-2.06%) ⬇️
src/Geometry/Primitives/Curves/Bezier.jl 54.87% <0.00%> (-1.72%) ⬇️
... and 55 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fb1e92d...bd942b3. Read the comment docs.

galran
galran previously approved these changes Oct 14, 2021
Fixes #298

had to update Schott glass catalog download URL since this was causing our documentation build to fail.
@BrianGun BrianGun merged commit ef3b1c9 into main Oct 15, 2021
@BrianGun BrianGun deleted the BrianGun/issue298 branch October 15, 2021 19:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants