Buone pratiche per la scrittura di algoritmi

Si tratta di quanto efficacemente possiamo esprimere un algoritmo a portata di mano. Ho bisogno di questo per il mio insegnamento universitario.

Capisco che non esiste un modo standard per scrivere uno pseudo codice. Autori diversi seguono convenzioni diverse.

Sarebbe utile se le persone qui sottolineano, il modo in cui seguono e pensano il migliore.

C'è qualche libro che si occupa di questo in dettaglio?

Scrivere lo pseudocodice è come scrivere il codice: non è particolarmente importante quale standard segua, purché tu (e le persone con cui scrivi) segua effettivamente qualche standard.

Ma per la cronaca, ecco lo standard idiosincratico che uso nei miei appunti di lezione, articoli di ricerca e libro in uscita.

• Utilizzare la sintassi imperativa standard per il flusso di controllo e l'accesso alla memoria - se, mentre, per, return, array [indice], funzione (argomenti). Scrivi "else if".

  • Ma usa $field(record)$ invece di record.fieldorecord->field

• $xy$x*ys ≤ t ¬ p $a\bmod b$a%b$s\le t$s <= t$\lnot p$!p π$\sqrt{x}$sqrt(x)$\pi$PI$\infty$MAX_INT

  • Ma usa per l'assegnazione, per evitare il problema.$x\gets y$==

  • Ma evita la notazione (e lo pseudocodice!) Se l'inglese è più chiaro.

    • Simmetricamente, evita l'inglese se la notazione è più chiara!

• Ridurre al minimo lo zucchero sintattico - Indicare la struttura a blocchi mediante rientro coerente (à la Python). Ometti parole chiave zuccherate come "inizio / fine" o "do / od" o "fi". Ometti i numeri di riga. Non non sottolineare parole chiave come "per" o "mentre" o "se" impostandole in un diverso typefaceo di stile . Mai. Non farlo.

  • Ma comporre i nomi degli algoritmi e le costanti in \ textc {Small Caps}, i nomi delle variabili in corsivo e le stringhe letterali in sans serif.

  • Ma aggiungi una piccola quantità di spazio "respiratorio" verticale ( \\[0.5ex]) tra blocchi di codice significativi.

• Non specificare dettagli non importanti. Se non importa quale ordine visiti i vertici, dì "per tutti i vertici".

Ad esempio, ecco una formulazione ricorsiva dell'algoritmo di spanning tree minimo di Borůvka . In precedenza ho definito come il grafico ottenuto da contraendo tutti i bordi nell'insieme e Flatten come una subroutine che rimuove anelli e bordi paralleli.G $G / L$$G$$L$

Uso il mio algorithmambiente LaTeX leggero per comporre pseudocodice. (È solo un tabbingambiente all'interno di un \fbox.) Ecco il mio codice sorgente per l'algoritmo di Borůvka:

\begin{algorithm}
	\textul{$\textsc{Borůvka}(G)$:}\+
\\	if $G$ has no edges\+
\\		return $\varnothing$\-
\\[0.5ex]
	$L \gets \varnothing$
\\	for each vertex $v$ of $G$\+
\\		add the lightest edge incident to $v$ to $L$\-
\\[0.5ex]
	return $L \cup \textsc{Borůvka}(\textsc{Flatten}(G / L))$
\end{algorithm}

Tendo ad usare qualcosa che assomiglia alla sintassi di Python. Python è già abbastanza vicino allo pseudocodice che in alcuni casi il mio pseudocodice può diventare un vero codice funzionante.

Se vuoi avere un codice definito (cioè poco o niente matematica, vicino alla vera programmazione) potresti prendere in considerazione l'idea di avere un codice che effettivamente viene compilato. Questo ha diversi vantaggi:

• Ottieni l'evidenziazione della sintassi ovunque.
• Il compilatore controlla la sintassi per te e applica la coerenza.
• Puoi testare le tue implementazioni per migliorare la qualità del codice.
• È possibile eseguire l'algoritmo e confrontare i runtime misurati con le analisi (motivando in tal modo tecniche di analisi avanzate).

Un professore della mia università fa questo nel suo corso di algoritmi. La sua lingua preferita è Modula. Non credo che la scelta particolare della lingua sia importante. Basta attenersi a uno (per paradigma) che si adatta meglio al tuo livello di astrazione.