Short projects

From Octave
Jump to: navigation, search

This is a list of small projects, the type that could be done in a couple of hours, maybe even minutes (no promises, we should all know about how estimates for software development work). This is probably the best place for users who want to start helping with Octave development (please, see also Octave coding guidelines). Please submit a fix to the bug tracker (not to the mailing list) and add a link to the item in question. Use the patch tracker for submissions unrelated to an existing bug.

The list is meant to be dynamic -- please add, remove, and comment on it. And since the things are likely to be of short duration, don't ask if is there is anyone already working on it. Projects of long duration should be added to the Projects page instead.

Most of the small and easy bugs are caught and fixed quickly by the Octave developers. The best way to catch an easy one is then to subscribe to the bug tracker (note that this has a lot of activity so you'll probably prefer to receive a digest).

Warning: do not simply add a patch/file to the bug or patch tracker. Always leave a comment at the same time, even if it just a simple "I prepared a change that should fix it". If there is no comment, it's hard to notice that a patch was added since there will be no notice on the discussion about it.

Bugs[edit]

Please help with the triage of existing bugs to populate the list of easy bugs below. You may find it useful to review the history of this short projects page, to give you an idea of past successful short projects.

  • #41674 - image package: temporary arrays in imresize are doubles
  • #8368 - imremap - Change to imremap to reduce memory footprint
  • #8369 - imresize - Change to imresize to reduce memory footprint

Code submitted, requires changeset & verification[edit]

Sometimes a standalone file or a diff file is submitted; Octave maintainers prefer a changeset though; preparing a changeset will expedite bug fixing.

  • #33935 - demo function humps is not defined

Missing functions[edit]

  • there is a list of missing functions for the image, mapping, optimization, and signal packages.
    • It would help to group the several missing functions in the image package, as per [1] (similar to what was done in the signal package wiki page); please keep the original alphabetical list intact.
  • openfig/savefig functions
    • These should be particularly easy additions as they are really just a wrapper on top of hgload/hgsave.
  • integral/integral2/integral3 functions
    • These are basically renamed versions of quad/dblquad/triplequad. It shouldn't be hard to make new functions which use the new integral naming system from Matlab. See also #42037.
      • one note, the new integral functions do change usage slightly from quad. E.g., quad and quadv were the only integrators that didn't require vectorized functions (as opposed to quadgk, quadcc, etc.). Also, passing parameters to integrating functions is more uniform than the different quad functions, where some (such as quad) does not include parameter passing. Compatibility should be checked for any wrapper made.

BIST tests[edit]

Write Built-In Self Tests (BIST) for a function. This improve's Octave's regression testing and ensures that we don't break anything when we add new features. Tests are written in the Octave m-file language and usually take less than 10 minutes to code for a single instance.

Miscellaneous[edit]

  • C++ cleanup of core after the switch to exceptions (late 2015). There are about 100 instances to clean up and each one takes less than 5 minutes. See Invert if/else/error.
  • Use "units.h" from GNU units in function units (from the Octave-Forge miscellaneous package) rather than making a system call and parsing its output (and having to handle multiple versions of it). This change will make it much more robust. It likely will alleviate the requirement of having GNU units installed in the system separately by the user. This requires knowledge of C (units is written on C) and C++ to write its Octave interface. It can be very easy if the units.h truly allows to be used as library or maybe impossible if it does not. This has not been investigated yet.
  • Use non-empty identifiers in all warnings and errors issued by Octave; see #39439, #39434. You may tackle as many or as few IDs as you have time for. As it is a widespread issue, finding occurrences in the source code should give you valuable knowledge about the way Octave files are organized.
    • When raising errors and warnings try to use the ids that are documented in the functions warning_ids and error_ids. If you really need a new id (please, first read the ones already there!), please add it to those functions as well. If you see other ids used in core that are not given by the functions mentioned above, please, report or submit patch for them, in addition to the patch to the calling functions as well.
  • extend sub2ind and ind2sub: #41796

Feature requests[edit]

  • #41844 - GUI Debug Menu could offer "Stop If..."
  • #41530 - Editor debug mode could show a dbup/dbdown GUI component
  • #41470 - offer editor preference "highlight current word"
  • #40211 - More compact output for structs and cell arrays
  • #32088 - Feature request: -ALL option for WHICH
  • #47464 - audioformats: a new function to get information on supported audio formats
  • #47239 - calling system without shell