jump-dev / jump-dev/PiecewiseLinearOpt.jl

Rewrite package

Open
#54 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Julia
Stars
58
Forks
24
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/jump-dev/PiecewiseLinearOpt.jl/pull/40

I think there is a lot of scope to more-or-less rewrite the entire package in "modern" Julia.

I would want to keep the public API, z = piecewiselinear(m, x, d, fd), so this would just be a backend re-organization of the current giant if switch.

It should be a fun and interesting project if someone wants to get their hands dirty.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading pull request #40 and inspecting the current implementation behind the public piecewiselinear(m, x, d, fd) API, especially its large conditional switch. Define the backend reorganization scope before changing anything. Done means the package is substantially rewritten in modern Julia while preserving the stated public API.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.