scalanlp/breeze

SparseArray/SparseVector.compact should be split into 2-3 functions

Open

#422 opened on Jul 23, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (690 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (3,453 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, SparseArray/SparseVector.compact does two separate things which are usually not intended to be done together. It should be split into three functions:

1: Add a def filter(predicate: T => Boolean): Unit function that allows specifying a predicate which is then used to strip certain values from the array/vector without reallocation.

2: Add a function called def tailor(): Unit that cuts down the memory usage to whatever is required to hold the values.

3: For backwards compatibility, replace the function compact with a function that calls filter(x => x == zero.zero) and then tailor().

Contributor guide

Research direction
Implement the three functions: filter, tailor, and update compact to call both. Ensure backward compatibility.
Tech stack
None
Domain
backenddata
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70