saransh-cpp / chaoticencryption.jl Goto Github PK

ChaoticEncryption.jl Version

0.1.1

Julia Version

1.7.2

Describe the bug

The push! function is slower in comparison to pre-allocating the array and replacing its element -

Steps to Reproduce

No response

Expected behaviour

No response

Relevant log output

No response

Additional context

Change the implementation to speed up the package

Description

name: Doc Preview Cleanup

on:
  pull_request:
    types: [closed]

jobs:
  doc-preview-cleanup:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout gh-pages branch
        uses: actions/checkout@v2
        with:
          ref: gh-pages
      - name: Delete preview and history + push changes
        run: |
            if [ -d "previews/PR$PRNUM" ]; then
              git config user.name "Documenter.jl"
              git config user.email "[email protected]"
              git rm -rf "previews/PR$PRNUM"
              git commit -m "delete preview"
              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
              git push --force origin gh-pages-new:gh-pages
            fi
        env:
            PRNUM: ${{ github.event.number }}

Motivation

No response

Possible Implementation

No response

Additional context

No response

@JuliaRegistrator register

Description

Migrate the code, examples, and documentation to Julia 1.7.2

Motivation

The failing doctests might pass, plus good to be on the latest Julia version as our CI runs on the same.

Possible Implementation

No response

Additional context

No response

Description

The documentation right now lacks examples for encrypting and decrypting images in-place. Add a small section showing the same.

Motivation

No response

Possible Implementation

No response

Additional context

No response

Description

Add more results by combining different images, dimensions, PRNGs etc.

Motivation

No response

Possible Implementation

No response

Additional context

No response

Description

I think a lot of deps are not being used, remove them.

Motivation

Redundant code

Possible Implementation

No response

Additional context

No response

Description

Right now the results look bland, add a table that looks something like this -

Results

Motivation

Would look good

Possible Implementation

No response

Additional context

No response

ChaoticEncryption.jl Version

dev

Julia Version

1.7.1

Describe the bug

Look at the documentation workflow. The tests are failing (are passing as warning intentionally) because of a type mismatch.

Steps to Reproduce

No response

Expected behaviour

No response

Relevant log output

No response

Additional context

No response

Description

Vectorize both the functions using the . operator to fasten the execution.

Motivation

Fast encryption and decryption!

Possible Implementation

No response

Additional context

No response

In both the substitution methods.

Description

Current documentation has only API documentation. Add more documentation and link the jupyter notebook examples.

Motivation

No response

Possible Implementation

No response

Additional context

No response

Description

Using Julia gives us the advantage of speed, hence adding some benchmarks would make sure that the speed doesn't go low. Add some benchmarks and also a new workflow to benchmark periodically and on a PR.

Motivation

The package should be fast, given that it is operating on 1000s of pixels.

Possible Implementation

BenchmarkTools.jl

Additional context

No response

Description

Right now the documentation for the module as a whole is missing. This should be added.

Motivation

No response

Possible Implementation

No response

Additional context

No response

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

References -

• handwrite-web
• handwrite-server

Separate out examples from the docstrings into a new examples folder. Maybe try out Pluto.jl for julia notebooks!