- API_CHANGE: Any changes to the project's API.
- DEPRECATED: Indication of features that will be removed in future releases.
- DOCUMENTATION: Something to do with the documentation.
- ENHANCEMENT: Improvements to existing features that do not introduce new functionality.
- FEATURE: New features added to enhance functionality.
- FIX: Resolved issues, bugs, or unexpected behavior.
- MAINTENANCE: Something which has to do with CI/CD or setup.
- REMOVED: Features or functionalities removed from the project.
The version is represented by three digits: a.b.c.
- Bump the first digit (a) for an API_CHANGE.
- Bump the second digit (b) for a big new FEATURE or a critical FIX.
- Bump the third digit (c) for a small new FEATURE, an ENHANCEMENT or a small FIX.
- Once a digit is bumped, set all the digits to its right to zero.
FEATURE:
symmetria.Permutation
: addlexicographic_rank
methodsymmetria.CycleDecomposition
: addlexicographic_rank
method
FEATURE:
symmetria.Permutation
: adddegree
methodsymmetria.CyclePermutation
: adddegree
methodsymmetria.Cycle
: adddegree
methodsymmetria.random
: add random module to create random permutations
ENHANCEMENT:
symmetria.Permutation
: change how the sign is computedsymmetria.Permutation
: add__new__
method to the classsymmetria.CyclePermutation
: add__new__
method to the classsymmetria.Cycle
: add__new__
method to the class
FEATURE:
cli
: add (minimal) command line interface
DOCUMENTATION:
- add documentation for command line interface
FEATURE:
symmetria.Permutation
: adddescribe
methodsymmetria.CyclePermutation
: adddescribe
methodsymmetria.Cycle
: adddescribe
method
DEPRECATED:
symmetria.Cycle
: delete method__pow__
as was not consistentsymmetria.Cycle
: deleteNotImplementedError
foris_regular
andis_conjugate
symmetria.CycleDecomposition
: deleteNotImplementedError
for__int__
DOCUMENTATION:
README.md
: improve section quickstartquickstart.rst
: improve examples
FEATURE:
generators
: add structure to generate permutationsgenerators
: addlexicographic
generatorgenerators
: add generator followingHeap
's algorithmgenerators
: add generator followingSteinhaus-Johnson-Trotter
's algorithm
FEATURE:
symmetria.Permutation
: addascents
methodsymmetria.CyclePermutation
: addascents
methodsymmetria.Permutation
: adddescents
methodsymmetria.CyclePermutation
: adddescents
methodsymmetria.Permutation
: addexceedances
methodsymmetria.CyclePermutation
: addexceedances
methodsymmetria.Permutation
: addrecords
methodsymmetria.CyclePermutation
: addrecords
method
MAINTENANCE:
tests
: Refactor. Now the code is more concise, and it is easier to add a new test.symmetria.elements._base.py
: Simplify the base class for elements object.
FEATURE:
symmetria.Permutation
: addis_regular
methodsymmetria.Cycle
: addis_regular
methodsymmetria.CyclePermutation
: addis_regular
methodsymmetria.Permutation
: addinversions
methodsymmetria.Cycle
: addinversions
methodsymmetria.CyclePermutation
: addinversions
methodsymmetria.Permutation
: addimage
propertysymmetria.Permutation
: add__pow__
methodsymmetria.Cycle
: add__pow__
methodsymmetria.CyclePermutation
: add__pow__
method
FEATURE:
symmetria.Permutation
: addis_conjugate
methodsymmetria.Cycle
: addis_conjugate
methodsymmetria.CyclePermutation
: addis_conjugate
method
FEATURE:
symmetria.Permutation
: addsgn
methodsymmetria.Cycle
: addsgn
methodsymmetria.CyclePermutation
: addsgn
methodsymmetria.Permutation
: addinverse
methodsymmetria.Cycle
: addinverse
methodsymmetria.CyclePermutation
: addinverse
methodsymmetria.Permutation
: addis_even
andis_odd
methodssymmetria.Cycle
: addis_even
andis_odd
methodssymmetria.CyclePermutation
: addis_even
andis_odd
methodssymmetria.Permutation
: addcycle_type
methodsymmetria.Cycle
: addcycle_type
methodsymmetria.CyclePermutation
: addcycle_type
method
MAINTENANCE:
tests.tests_meta.test_order.py
: add test suite for order of methodsdocs._static.symmetria.png
: logo for symmetria.github.workflows.tests
: add doctest
MAINTENANCE:
.github
: add workflowstests.yml
,code-style.yml
,release.yml
andcheck-pr-title.yml
.github.pull_request_template.md
: add pull request template.github.ISSUE_TEMPLATE
: add templates for issuestests
: in module tests we import as in the API.pre-commit-config.yml
: addcheck-toml
andname-tests-test
docs
: first version of the docs implemented
🎉🚀 First version of symmetria
🚀🎉