Remove ! from _substitute_pixel + v0.4.0 (#84)

Author: Saransh-cpp

CHANGELOG.md

@@ -1,14 +1,12 @@
 # Unreleased
 
+# v0.4.0
+
 ## Features
 
 -   Introduced `save_img` argument in encryption/decryption functions to manually save the resultant image ([#83](https://github.com/Saransh-cpp/ChaoticEncryption.jl/pull/83))
 -   Introduced `debug` argument in encryption/decryption functions to print debug statements ([#83](https://github.com/Saransh-cpp/ChaoticEncryption.jl/pull/83))
 
-## Bug fixes
-
--   Renamed `_substitute_pixel` to `_substitute_pixel!` to show the inplace alterations ([#83](https://github.com/Saransh-cpp/ChaoticEncryption.jl/pull/83))
-
 ## Optimisations
 
 -   Added `Bool` type to the `inplace` variable ([#83](https://github.com/Saransh-cpp/ChaoticEncryption.jl/pull/83))

Project.toml

@@ -1,7 +1,7 @@
 name = "ChaoticEncryption"
 uuid = "8967581b-3fa7-4a60-bbed-8fff548a82df"
 authors = ["Saransh Chopra"]
-version = "0.3.2"
+version = "0.4.0"
 
 [deps]
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"

docs/src/devdocs/algorithms.md

@@ -15,7 +15,7 @@ ChaoticEncryption._substitution(
     inplace::Bool=false,
     debug::Bool=false
 )
-ChaoticEncryption._substitute_pixel!(
+ChaoticEncryption._substitute_pixel(
     pixel::RGB,
     key::Int64
 )

src/substitution.jl

@@ -59,7 +59,7 @@ function _substitution(
 
     # substitute all pixels in one go
     debug && @info "Substituting all pixels"
-    @. image = _substitute_pixel!(image, keys)
+    @. image = _substitute_pixel(image, keys)
 
     if debug
         if type == :encrypt
@@ -91,7 +91,7 @@ See [`_substitution`](@ref) for more details.
 # Returns
 - `pixel::RGB`: Substituted pixel.
 """
-_substitute_pixel!(pixel::RGB, key::Int64) = RGB(
+_substitute_pixel(pixel::RGB, key::Int64) = RGB(
     (trunc(Int, pixel.r * 255) ⊻ key) / 255,
     (trunc(Int, pixel.g * 255) ⊻ key) / 255,
     (trunc(Int, pixel.b * 255) ⊻ key) / 255