Indexer (programming): Difference between revisions

Revision as of 11:06, 3 January 2025

Latest revision as of 06:39, 18 February 2025

(8 intermediate revisions by 4 users not shown)

Line 1:

{{Short description|Object-oriented programming concept}}

{{Confusing|reason=is this a C# or a general OO concept? Surely the interesting thing is the use of the keyword 'this', not what is emphasised here? Why is this whole article only sourced to one C# forum post (the other forum post is a dead link). Maybe an example of use of the example class would demonstrate the purpose of the construct. Wikipedia is not a manual, guidebook or textbook [[WP:NOTHOWTO]].|date=April 2015}}

In [[object-oriented programming]], an '''indexer''' allows instances of a particular class or struct to be indexed just like arrays.<ref>{{cite web|access-date=2011-08-01 |author=jagadish980 |date=2008-01-29 |website=SURESHKUMAR.NET FORUMS |title=C# - What is an indexer in C# |url=http://forums.sureshkumar.net/vb-asp-net-interview-technical-questions/16320-c-what-indexer-c.html |archive-url=https://web.archive.org/web/20090922193214/http://forums.sureshkumar.net/vb-asp-net-interview-technical-questions/16320-c-what-indexer-c.html |archive-date=September 22, 2009 }}</ref> It is a form of [[operator overloading]].

== Implementations ==

=== C++ ===

In C++ one can emulate indexing by overloading the {{c++|[]}} operator. Specifically, theThe expression {{c++|a[b...]}} translates to a call to the user-defined function {{c++|operator[]}} as {{c++|(a).operator[](b...)}}.<ref>{{cite web|url=https://en.cppreference.com/w/cpp/language/operators|title=cppreferenceC++ operator overloading}}</ref>. Here is an example,

==== Example ====

<syntaxhighlight lang="c++">

struct vector {

int size; double* data;

vector(int n) { size = n; data = new double[n](); }

~vector(){ size = 0; delete[] data; }

double& operator[](int i) { return data[i]; }

};

#include<iostream>

#include <iostream>

int main(){

int main() {

vector v(3);

for (int i = 0; i < v.size; i++) v[i] = i + 1;

for (int i = 0; i < v.size; i++) std::cout << v[i] << "\n";

return 0;

}

</syntaxhighlight>

=== C sharp# ===

Indexers are implemented through the get and set [[Mutator method|accessor]]s for the {{C_sharp|operator[]}}. They are similar to [[Property (programming)|properties]], but differ by not being [[Static method|static]], and the fact that indexers' accessors take parameters. The get and set accessors are called as methods using the parameter list of the indexer declaration, but the set accessor still has the implicit {{C_sharp|value}} parameter.

==== Example 1====

<syntaxhighlight lang="csharp">

public class vectorVector
{

private double[] data_data;

public vector(int n){data = new double[n];}

public int size => data.Length;

public double this[int i]{ get => data[i]; set => data[i]=value;}

public static void MainVector(int n){

{

var v=new vector(3);

for(int i _data =0;i<v.size;i++) vnew double[in]=i+1;

}

for(int i=0;i<v.size;i++) System.Console.WriteLine(v[i]);

}

public int Size => _data.Length;

public double this[int i]

{

get => _data[i];

set => _data[i] = value;

}

public static void Main()

{

var vector = new Vector(3);

for (var i = 0; i < vector.Size; i++)

vector[i] = i + 1;

for (var i = 0; i < vector.Size; i++)

System.Console.WriteLine(vector[i]);

}

}

</syntaxhighlight>

Line 100 ⟶ 114:

=== PHP ===

In [[PHP]] indexing can be implemented via the predefined {{pythoncode|ArrayAccess}} interface,<ref>{{cite web|url=https://www.php.net/manual/en/class.arrayaccess.php|title=PHP ArrayAccess interface}}</ref>,

<syntaxhighlight lang="php">

class Vector implements ArrayAccess

<?php

{

class vector implements ArrayAccess {

function __construct(int $n) {

$this->size = $n;

$this->data = array_fill(0, $n, 0);

}

public function offsetGet($offset): mixed{

public function offsetGet($offset): mixed {

return $this->data[$offset];

}

public function offsetSet($offset, $value): void{

public function offsetSet($offset, $value): void {

$this->data[$offset] = $value;

}

public function offsetExists($offset):bool{}

public function offsetUnsetoffsetExists($offset):void bool {}

public function offsetUnset($offset): void {}

}

$v=new vector(3);

$vector = new Vector(3);

for($i=0;$i<$v->size;$i++)$v[$i]=$i+1;

for($i=0;$i<$v->size;$i++)print "{$v[$i]}\n";

for ($i = 0; $i < $vector->size; $i++) $vector[$i] = $i + 1;

?>

for ($i = 0; $i < $vector->size; $i++) print "{$vector[$i]}\n";

</syntaxhighlight>

=== Python ===

In [[Python (programming language)|Python]] one implements indexing by overloading the {{python|__getitem__}} and {{python|__setitem__}} methods,

<syntaxhighlight lang="python">

import array

class vector (object) :

def __init__ (self,n) :

self.size=n

self.data=array.array('d',[0.0]*n)

def __getitem__ (self,i) : return self.data[i]

def __setitem__ (self,i,value) : self.data[i]=value

class Vector(object):

v=vector(3)

def __init__(self, n: int):

for i in range(v.size) : v[i]=i+1

for i in range(v self.size) := print(v[i])n

self.data = array.array("d", [0.0] * n)

def __getitem__(self, i: int):

return self.data[i]

def __setitem__(self, i: int, value):

self.data[i] = value

vector = Vector(3)

for i in range(vector.size):

vector[i] = i + 1

for i in range(vector.size):

print(vector[i])

</syntaxhighlight>

=== Rust ===

[[Rust (programming language)|Rust]] provides the {{Mono|std::ops::Index}} trait.<ref>{{cite web |title=Index in std::ops - Rust |url=https://doc.rust-lang.org/std/ops/trait.Index.html |website=doc.rust-lang.org |access-date=11 January 2025}}</ref>

<syntaxhighlight lang="rust">

use std::ops::Index;

enum Nucleotide {

A,

C,

G,

T,

}

struct NucleotideCount {

a: usize,

c: usize,

g: usize,

t: usize,

}

impl Index<Nucleotide> for NucleotideCount {

type Output = usize;

fn index(&self, nucleotide: Nucleotide) -> &Self::Output {

match nucleotide {

Nucleotide::A => &self.a,

Nucleotide::C => &self.c,

Nucleotide::G => &self.g,

Nucleotide::T => &self.t,

}

}

}

let nucleotide_count = NucleotideCount {a: 14, c: 9, g: 10, t: 12};

assert_eq!(nucleotide_count[Nucleotide::A], 14);

assert_eq!(nucleotide_count[Nucleotide::C], 9);

assert_eq!(nucleotide_count[Nucleotide::G], 10);

assert_eq!(nucleotide_count[Nucleotide::T], 12);

</syntaxhighlight>

=== Smalltalk ===

In [[Smalltalk]] one can emulate indexing by (e.g.) defining the {{smalltalk|get:}} and {{smalltalk|set:value:}} instance methods. For example, in [[GNU Smalltalk]],

<syntaxhighlight lang="smalltalk">

Object subclass: vector [ |data| ]

vector class extend [ new: n [ |v| v:=super new. v init: n. ^v] ]

vector extend [ init: n [ data:= Array new: n ] ]

vector extend [ size [ ^(data size) ] ]

vector extend [ get: i [ ^(data at: i) ] ]

vector extend [ set: i value: x [ data at: i put: x ] ]

v:=vector new: 3

1 to: (v size) do: [:i| v set: i value: (i+1) ]

1 to: (v size) do: [:i| (v get: i) printNl ]

</syntaxhighlight>

== See also ==

{{Portal|Computer programming}}

* [[Mutator method]]

Line 145 ⟶ 225:

{{Reflist}}

[[Category:Articles with example C++ code]]

<!--Categories-->

[[Category:Articles with example C Sharp code]]

[[Category:Articles with example Python (programming language) code]]

[[Category:Articles with example PHP code]]

[[Category:Articles with example Rust code]]

[[Category:Programming language topics]]

[[Category:Object-oriented programming]]