JuliaDiff / JuliaDiff/ForwardDiff.jl

recommended method for unit testing

Open
#284 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
1k
Forks
160
PR merge metrics
No merged PRs in 30d

Description

Suppose I write a function f(x, y). Is there a recommended API for unit testing that it works (at least runs) with ForwardDiff? For example, the minimum requirement would be that it is capable of handling Dual numbers, and returns Duals too (is there anything else?).

Currently I am just generating arguments of random Duals and then check that the return type has the same element type. But it is pretty ad hoc, and I would prefer to do the right thing.

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

The issue names no file, test, or entry point. Start by clarifying whether the goal is a documented testing convention or a new API, then define what compatibility means beyond accepting and returning Dual values; completion criteria are not specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
testing
Issue type
Feature
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.