JuliaSmoothOptimizers / JuliaSmoothOptimizers/PartitionedVectors.jl

Developper documentation

Open
#34 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
8
Forks
2
PR merge metrics
No merged PRs in 30d

Description

We should explain some code:
- general scheme to define dedicated methods depending the usage of PartitionedVector parameters: `Val{true}` and `Val{false}`;
- mention #23 to explain how the partitioned dot product is computed.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing how PartitionedVector parameters use Val{true} and Val{false}, then read issue #23 for the partitioned dot-product explanation. Done means the developer documentation explains the general method-definition scheme and links to or incorporates the computation details from issue #23.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.