La mia raccolta sequenziale dovrebbe iniziare dall'indice 0 o dall'indice 1?

Sto creando un modello a oggetti per un dispositivo con più canali. I nomi usati tra il cliente e io sono Channele ChannelSet. ("Set" non è semanticamente accurato, perché è ordinato e non è un set corretto. Ma questo è un problema per un altro tempo.)

Sto usando C #. Ecco un esempio di utilizzo di ChannelSet:

// load a 5-channel ChannelSet
ChannelSet channels = ChannelSetFactory.FromFile("some_5_channel_set.json");

Console.Write(channels.Count);
// -> 5

foreach (Channel channel in channels) {
    Console.Write(channel.Average);
    Console.Write(",  ");
}
// -> 0.3,  0.3,  0.9,  0.1,  0.2

Tutto è dandy. Tuttavia, i client non sono programmatori e saranno assolutamente confusi dall'indicizzazione zero: il primo canale è il canale 1 per loro. Ma, per coerenza con C #, voglio mantenere l' ChannelSetindicizzato da zero .

Questo sicuramente causerà alcune disconnessioni tra il mio team di sviluppo e i client quando interagiscono. Ma peggio, qualsiasi incoerenza nel modo in cui questo viene gestito all'interno della base di codice è un potenziale problema. Ad esempio, ecco una schermata dell'interfaccia utente in cui l'utente finale ( che pensa in termini di 1 indicizzazione ) sta modificando il canale 13:

SaveAlla fine quel pulsante genererà del codice. Se ChannelSetè 1 indicizzato:

channels.GetChannel(13).SomeProperty = newValue;  // notice: 13

o questo se è indicizzato zero:

channels.GetChannel(12).SomeProperty = newValue;  // notice: 12

Non sono davvero sicuro di come gestirlo. Sento che è buona prassi mantenere un elenco di cose ordinate e indicizzate per intero (le ChannelSet) coerenti con tutte le altre interfacce di array e liste nell'universo C # (a zero indicizzazione ChannelSet). Ma poi ogni parte di codice tra l'interfaccia utente e il backend avrà bisogno di una traduzione (sottrazione per 1) e sappiamo tutti quanto siano già insidiosi e comuni errori off-by-one.

Quindi, una decisione come questa ti ha mai morso? Devo zero indice o un indice?

Sembra che tu stia confondendo l'identificatore Channelcon la sua posizione all'interno di a ChannelSet. Di seguito è la mia visualizzazione di come il tuo codice / commenti apparirebbe al momento:

public sealed class ChannelSet
{
    private Channel[] channels;
    /// <summary>Retrieves the specified channel</summary>
    /// <param name="channelId">The id of the channel to return</param>
    Channel GetChannel(int channelId)
    {
        return channels[channelId-1];
    }
}

Sembra che tu abbia deciso che, poiché Channelall'interno di a ChannelSetsono identificati da numeri che hanno un limite superiore e inferiore, devono essere indici e quindi poiché sono basati su C #, 0. Se il modo naturale di fare riferimento a ciascuno dei canali è di un numero compreso tra 1 e X, fare riferimento a loro con un numero compreso tra 1 e X. Non cercare di forzarli a essere indici.

Se vuoi davvero fornire un modo per accedervi con un indice basato su 0 (che vantaggio offre questo utente finale o gli sviluppatori che consumano il codice?), Allora implementa un indicizzatore :

public sealed class ChannelSet
{
    private Channel[] channels;
    /// <summary>Retrieves the specified channel</summary>
    /// <param name="channelId">The id of the channel to return</param>
    public Channel GetChannel(int channelId)
    {
        return channels[channelId-1];
    }

    /// <summary>Return the channel at the specified index</summary>
    public Channel this[int index]
    {
        return channels[index];
    }
}

Mostra l'interfaccia utente con l'indice 1, usa l'indice 0 nel codice.

Detto questo, ho lavorato con dispositivi audio come questo e ho usato l'indice 1 per i canali e progettato il codice per non utilizzare mai "Index" o indicizzatori per evitare la frustrazione. Alcuni programmatori si sono ancora lamentati, quindi l'abbiamo cambiato. Quindi altri programmatori si sono lamentati.

Basta sceglierne uno e attenersi ad esso. Ci sono problemi più grandi da risolvere nel grande schema di ottenere software fuori dalla porta.

Utilizza entrambi.

Non mescolare l'interfaccia utente con il codice principale. Internamente (come libreria) è necessario codificare "senza sapere" come ciascun elemento dell'array verrà chiamato dall'utente finale. Utilizzare le matrici e le raccolte "naturali" con indice 0.

La parte del programma che unisce i dati con l'interfaccia utente, la vista, dovrebbe occuparsi di tradurre correttamente i dati tra il modello mentale dell'utente e la 'Libreria' che svolge il lavoro effettivo.

Perché è meglio?

• Il codice può essere più pulito, nessun trucco per tradurre l'indicizzazione. Questo aiuta anche i programmatori non aspettandosi che seguano e ricordino di usare convenzioni innaturali.
• Gli utenti useranno l'indicizzazione che si aspettano. Non vuoi infastidirli.

Puoi vedere la collezione da due diverse angolazioni.

(1) È, in primo luogo, una raccolta sequenziale regolare , come una matrice o un elenco. L'indice da 0è ovviamente la soluzione giusta allora, seguendo la convenzione. Allocare abbastanza voci e mappare il numero del canale agli indici, il che è banale (basta sottrarre 1).

(2) La tua raccolta è essenzialmente una mappatura tra identificatori di canale e oggetti info canale. Accade semplicemente che gli identificatori di canale siano un intervallo sequenziale di numeri interi; domani potrebbe essere qualcosa di simile [1, 2, 3, 3a, 4, 4.1, 6, 8, 13]. Si utilizza questo set ordinato come chiavi di mappatura.

Scegli uno degli approcci, documentalo e seguilo. Dal punto di vista della flessibilità, andrei con (2), perché la rappresentazione del numero del canale (almeno il nome visualizzato) è relativamente probabile che cambi in futuro.

Tutti e il loro cane usano indici a base zero. L'uso di indici a base singola all'interno dell'applicazione causerà problemi di manutenzione per sempre.

Ora ciò che visualizzi in un'interfaccia utente, dipende interamente da te e dal tuo cliente. Visualizza i + 1 come numero di canale, insieme al canale #i, se questo rende felice il tuo cliente.

Se esponi una classe, la esponi ai programmatori. Le persone che sono confuse da un indice a base zero non sono programmatori, quindi qui c'è una disconnessione.

Sembra che ti preoccupi della conversione tra interfaccia utente e codice. Se questo ti preoccupa, crea una classe con la rappresentazione dell'interfaccia utente di un numero di canale. Una chiamata che trasforma il numero 12 nella rappresentazione dell'interfaccia utente "Canale 13" e una chiamata che trasforma "Canale 13" nel numero 12. Dovresti farlo comunque, nel caso in cui il cliente cambi idea, quindi ci sono solo due righe di codice cambiare. E funziona se il cliente richiede numeri romani o lettere dalla A alla Z.

Stai mescolando due concetti: indicizzazione e identità. Non sono la stessa cosa e non devono essere confusi.

Qual è lo scopo dell'indicizzazione? Accesso casuale veloce. Se la prestazione non è un problema e, data la tua descrizione, non lo è, l'utilizzo di una raccolta con un indice non è necessario e probabilmente accidentale.

Se tu (o la tua squadra) siete confusi dall'indice rispetto all'identità, allora potete risolvere quel problema non avendo un indice. Utilizzare un dizionario o un enumerabile e ottenere il canale in base al valore.

channels.First(c=> c.Number == identity).SomeProperty = newValue;
channels[identity].SomeProperty = newValue;

Il primo è più chiaro, il secondo è più breve: possono o meno essere tradotti nello stesso IL, ma in entrambi i casi, dato che lo stai usando per un menu a discesa, dovrebbe essere abbastanza veloce.

Stai esponendo un'interfaccia attraverso la tua ChannelSetclasse con cui ti aspetti che i tuoi utenti interagiscano. Lo renderei il più naturale possibile per loro. Se prevedete che i vostri utenti inizieranno a contare da 1 invece di 0, esponete questa classe e il suo utilizzo tenendo presente tale aspettativa.

L'indicizzazione basata su 0 era popolare e difesa da persone importanti, poiché la dichiarazione mostra le dimensioni dell'oggetto.

Con i computer moderni, con i computer che verranno utilizzati dagli utenti, la dimensione dell'oggetto è importante?

Se il tuo langauge (C #) non supporta un modo chiaro di dichiarare il primo e l'ultimo elemento di un array, puoi semplicemente dichiarare un array più grande e usare costanti dichiarate (o variabili dinamiche) per identificarti all'inizio e alla fine logici di l'area attiva dell'array.

Per gli oggetti dell'interfaccia utente, puoi quasi certamente permetterti di utilizzare un oggetto dizionario per la tua mappatura (se hai 10 milioni di oggetti, hai un problema con l'interfaccia utente) e se il miglior oggetto dizionario risulta essere un elenco con spazio sprecato alle due estremità, non hai perso nulla di importante.