Document why re-aliasing is important

Aperta
#17 1 commento 3 reazioni 0 assegnatari Vedi su GitHub

@devmotion ci sta già lavorando.

Dal 4/9/2025.

  • #39 di @devmotion — aperta

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
julia
Ambito
documentation

Direzione di ricerca

Inizia leggendo la documentazione che menziona il re-aliasing e la documentazione di ForwardDiff.hessian!, quindi esamina l’API DiffResults a cui fa riferimento l’esempio. Chiarisci se il re-aliasing del risultato è ancora necessario e documenta il motivo, oppure aggiorna l’esempio e la spiegazione se non è più necessario.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The documentation points out, that it really important to re-alias the result, e.g. in

result = ForwardDiff.hessian!(result, f, x);

It says that more information for why this is done can be found in the documentation of ForwardDiff.hessian!. Unfortunately, the according documentation does not talk about DiffResults at all so I remain curious why re-aliasing is necessary here. Is re-aliasing no longer needed?

Lingua principale
Julia
Stelle
37
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di JuliaDiff/DiffResults.jl

Tutte le issue di JuliaDiff/DiffResults.jl

Issue simili

Altre issue su Julia

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.