v0.4.0

ChaoticEncryption v0.4.0

Diff since v0.3.2

Features

• Introduced save_img argument in encryption/decryption functions to manually save the resultant image (#83)
• Introduced debug argument in encryption/decryption functions to print debug statements (#83)

Optimisations

• Added Bool type to the inplace variable (#83)

Documentation

• Made everything strict except :missing docs (#83)

Closed issues:

• REGISTER! (#20)

Merged pull requests:

• Simplify examples and doctests (#80) (@Saransh-cpp)
• Use TestImages.jl instead of adding test images to the repository (#81) (@Saransh-cpp)
• Remove cron job (#82) (@Saransh-cpp)
• Introduce save_img, debug, and add ! to _substitute_pixel (#83) (@Saransh-cpp)
• Remove ! from _substitute_pixel + v0.4.0 (#84) (@Saransh-cpp)

v0.3.2

ChaoticEncryption v0.3.2

Diff since v0.3.1

ChaoticEncryption v0.3.2

Optimisations

• Added _substitute_pixel to perform substitution for a single pixel, and replaced the current implementation of substitution algorithm with the same (#78, @Saransh-cpp)

Merged pull requests:

• Introduce _substitute_pixel to simplify everything (#78) (@Saransh-cpp)
• v0.3.2 (#79) (@Saransh-cpp)

v0.3.1

ChaoticEncryption v0.3.1

Diff since v0.3.0

Optimisations

• Completely vectorized the substitution algorithm, removing the nested for loop (#75, @Saransh-cpp)

Misc

• Added utility funtions for ChaoticEncryption.jl developers (#75, @Saransh-cpp)

Closed issues:

• Vectorize substitution algorithm's functions (#46)
• Add examples for ! methods (#74)

Merged pull requests:

• Add Pkg eval badge (#73) (@Saransh-cpp)
• Speed (#75) (@Saransh-cpp)
• Add a minimal example for ! methods (#76) (@Saransh-cpp)
• Bump! (#77) (@Saransh-cpp)

v0.3.0

ChaoticEncryption v0.3.0

Diff since v0.2.0

Breaking changes

• ChaoticEncryption.jl now only supports Julia versions greater than 1.6 (#60, @Saransh-cpp)

Optimisations

• Refactored substitution_encryption and substitution_decryption under _substitution function (#55, @Saransh-cpp)
• Images can now be encrypted/decrypted inplace (#58, @Saransh-cpp)

Documentation

• Fixed some documentation issues and rearranged the pages (#56, @Saransh-cpp)
• Rearranged API documentation (#58, @Saransh-cpp)
• Now only doctests are strict (#59, @Saransh-cpp)
• Generated missing docs for previous versions (#61, #62, @Saransh-cpp)
• Added tutorials for PRNGs and substitution algorithm in the docs (#69, @Saransh-cpp)

Features

• Added substitution_encryption! and substitution_decryption! to encrypt/decrypt images inplace (#58, @Saransh-cpp)

CI

• Improved documentation deployment (#59, #61, #62, #64, #65, #66, @Saransh-cpp)
• Documentation previews are now regularly deleted (#67, @Saransh-cpp)

Closed issues:

• Add docstring for the module (#47)
• Add more documentation (#54)
• Add CI to clean gh-pages (#62)

Merged pull requests:

• Add DocMeta.setdocmeta! in make.jl (#53) (@Saransh-cpp)
• Refactor substitution functions (#55) (@Saransh-cpp)
• Add dev docs + rearrange docs (#56) (@Saransh-cpp)
• Add inplace encryption and decryption (#58) (@Saransh-cpp)
• Add push_preview and make only doctests strict (#59) (@Saransh-cpp)
• Support only Julia LTS and later releases (#60) (@Saransh-cpp)
• Add DOCUMENTER_KEY (#61) (@Saransh-cpp)
• Add doc versions (#63) (@Saransh-cpp)
• Add missing dev docs (#64) (@Saransh-cpp)
• Fix dev docs (#65) (@Saransh-cpp)
• Fix dev docs (#66) (@Saransh-cpp)
• Redundant pr preview docs (#67) (@Saransh-cpp)
• Add docstring (#68) (@Saransh-cpp)
• Add tutorials in docs (#69) (@Saransh-cpp)
• PR bot + inplace -> Symbol (#70) (@Saransh-cpp)
• v0.3.0! (#71) (@Saransh-cpp)
• Fix release (#72) (@Saransh-cpp)

v0.2.0

ChaoticEncryption v0.2.0

Diff since v0.1.1

Breaking changes

• All the types have been migrated to Julia v1.7.2 (#32, @Saransh-cpp)

Features

• lorenz_key and logistic_key are more flexible and independent now (one can specify the upper bound of pseudo-random number, hence now they are not limited only to image encryption) (#39, @Saransh-cpp)

Optimisations

• logistic_key now pre-allocates the memory, making the function twice as fast as before (#48, @Saransh-cpp)
• Removed redundant dependencies (#50, @Saransh-cpp)

Documentation

• Updated all the examples to go with Julia v1.7.2 migration (#34, @Saransh-cpp)
• All the docstrings have been updated to follow Julia v1.7.2 and to pass the doctests (#32, @Saransh-cpp)

CI

• Doctests now fail on encountering an error (#40, @Saransh-cpp)

Contributors

• @Saransh-cpp
• @Muthukumar-Muthu

v0.1.1

ChaoticEncryption v0.1.1

Documentation

• Improved the docstring examples (#24, @Saransh-cpp)
• Added doctests (#24, @Saransh-cpp)

Misc

• Created a CHANGELOG file (#25, @Saransh-cpp)
• Created a new logo (#23, @Saransh-cpp)
• Added issue and PR templates (#22, @Saransh-cpp)

v0.1.0

ChaoticEncryption v0.1.0

NOTE: Most of the additions/changes were made directly to the master branch (i.e. not through a PR), hence, most of the changes won't have a PR associated with them. This will change in the next versions of ChaoticEncryption.jl!

Features

• Implemented the Logistic Map Pseudo-Random Number Generator (@Saransh-cpp)
• Implemented the Lorenz System of Differential Equations Pseudo-Random Number Generator (@Saransh-cpp)
• Implemented the substitution encryption and decryption algorithm (@Saransh-cpp)
• Now the encryption and decryption functions will return the encrypted image (#11, @Saransh-cpp)
• Allow users to pass a loaded image instead of image's path (#19, @Saransh-cpp)

Bug fixes

• Fixed the implementation of positional arguments (#19, @Saransh-cpp)

Documentation

• Added GitHub's special markdown files (#1, @Saransh-cpp)
• Added docstrings and latexified them (#7, @Saransh-cpp)
• Update README.md with all the relevant information (#8, @Saransh-cpp)
• Added complete documentation and deployed it on GitHub Pages (https://saransh-cpp.github.io/ChaoticEncryption.jl/) (@Saransh-cpp)
• Added example notebooks (#11, @Saransh-cpp)

CI

• Created the CI pipeline (@Saransh-cpp)
• Optimized the CI pipeline (#18, @Saransh-cpp)
• Added CI for documentation deployment (@Saransh-cpp)

Misc

• Removed redundant dependencies (#19, @Saransh-cpp)