Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

c++ two versions of overloading subscript operator

My question is about the difference between:

const T& operator[](const int nIndex) const;

and:

T& operator[](const int nIndex);

Why would I need both of them defined in a class, what's the purpose? Wouldn't the latter suffice?

like image 576
Simon Righley Avatar asked Mar 14 '13 15:03

Simon Righley


People also ask

Can we overload subscript operator?

The subscript operator [] is normally used to access array elements. This operator can be overloaded to enhance the existing functionality of C++ arrays.

What is subscript operator in C?

The subscript operator is commutative. Therefore, the expressions array[index] and index[array] are guaranteed to be equivalent as long as the subscript operator is not overloaded (see Overloaded Operators). The first form is the most common coding practice, but either works.

What are the two types of overloading in C++?

There are mainly two types of overloading, i.e. function overloading and operator overloading.


2 Answers

A member function declaration with const at the end of it allows that function to be called even on a const object. This only makes sense for member functions that don't modify the state of the object.

Let's say the class you have that overloads these operators is called X. Presumably it behaves a bit like a container, giving access to the elements it contains through this operator[].

Now let's say the user wants to use a const X:

const X x = /* fill it */;
use(x[0]);

Should the user be allowed to do this? Probably. If they want a container that is immutable, then let them have it. If you didn't provide the const version of operator[], they wouldn't be able to do this. They're not trying to modify the container after all, they're just looking at its contents.

Now why make the const version of operator[] return a const reference? Because it has to. It's returning a reference to a member of the class itself. If the container was const and returned a non-const reference, the caller would be able to modify its internals just by using this operator:

const X x = /* fill it */;
x[0].modify();

Oh dear, we modify the state of x even though it's const. This would be bad and in fact, the compiler won't even let you do it.

like image 195
Joseph Mansfield Avatar answered Sep 22 '22 23:09

Joseph Mansfield


Those are member functions of a class, and the version will be chosen based on whether that class in used as a const context.

This version will be called when [] is used on a object in a const context. It preserves the const-ness of the returned element.

const T& operator[](const int nIndex) const;

This version will be called when [] is used on a non-const object. It specifies that when your object isn't const, you'll get an element that you can modify, allowing code like myObject[0] = 10;

T& operator[](const int nIndex);
like image 23
Drew Dormann Avatar answered Sep 26 '22 23:09

Drew Dormann