JuliaImages / JuliaImages/ImageBase.jl

deprecate `varfinite` in favor of `varmult_finite`

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

Nobody has claimed this yet.

Dominant language
Julia
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Because it is unclear what operation is applied when we compute abs2(c::RGB), in ColorVectorSpace v0.9 we've removed abs2 and deprecated var in favor of varmult. Then we reimplemented abs2 again with proper deprecation (see also https://github.com/JuliaGraphics/ColorVectorSpace.jl/pull/172)

In #17 efforts are paid to provide a consistent and more functional API for meanfinite, minimum_finite, maximum_finite and sumfinite to their corresponding mean, minimum, maximum and sum. It makes sense to do the same thing for varfinite here.

The proposed API is:

varmult(op, itr; corrected::Bool=true, mean=Statistics.mean(itr), dims=:)
varmult_finite(op, itr; corrected::Bool=true, mean=Statistics.mean(itr), dims=:)

with deprecation

# ⋅ is the inner product
@deprecate var(A; kwargs...) varmult_finite(⋅, A; kwargs...)

cc: @jagoosw

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 locating the existing varfinite, var, and varmult entry points and any tests covering finite variance operations. Compare their current interfaces with the proposed varmult_finite API, then update the deprecation behavior and tests so the renamed operation and keyword arguments are covered.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.