JuliaCollections/DataStructures.jl

Add features to LinkedList

Open

#443 opened on Aug 24, 2018

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Julia (261 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (738 stars)
PR merge metrics
 (Avg merge 9d 21h) (5 merged PRs in 30d)

Description

When looking at #442 I noticed just how featureless our LinkedList is. In particular, as pointed out by #442 we have no mutating operations.

I think adding some of the missing methods would be great for someone new to julia. Since implementing a linked list is like DataStructures101.

Here is a list of functions I think should be implemented. Feel free to suggest more.

  • getindex
  • setindex!
  • delete! with overloads both for single indexes and for ranges.
  • append!
  • The iterator traits (or are the defaults right?)

Contributor guide

Research direction
Start by examining the existing LinkedList implementation in the DataStructures.jl package (likely in src/linked list.jl). Look at how other similar data structures implement getindex, setindex!, delete!, append!, and iterator traits. Pay attention to Julia's generic programming patterns and the package's coding style. Check the referenced issue #442 for context on why mutating operations are needed. After understanding the current code, implement one method at a time, following the checklist in the issue description.
Tech stack
None
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia programming languageLinked list conceptsReading existing code in DataStructures.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80