RFR: 8331193: Return references when possible in GrowableArray

[Stefan Karlsson]

On Fri, 26 Apr 2024 11:58:43 GMT, Johan Sjölen <jsjolen at openjdk.org> wrote:

> Hi,
> 
> This PR introduces the possibility of using references more often when using GrowableArray, where as previously this was only possible when using the `at()` method. This lets us avoid copying and redundant method calls and makes the API more streamlined. After the patch, we can use `at_grow` just like `at` works. The same goes for `top`, `first`, and `last`.
> 
> 
> Some example code:
> ```c++
> // Before this patch this worked:
> GrowableArray<int> arr(8,8,-1); // Pre-fill with 8 -1s
> int& x = arr.at(7);
> if (x == -1) {
>   x = 2;
> }
> assert(arr.at(7) == 2, "this holds");
> // but this was forbidden
> int& x = arr.at_grow(9, -1); // Compilation error! at_grow returns E, not E&
> // so we had to do
> int x = arr.at_grow(9, -1);
> if (x == -1) {
>   arr.at_put(9, 2);
> }
> 
> 
> Thanks.

There are two `at` functions, with and without const:

  E& at(int i) {
...
  E const& at(int i) const {


This change makes the following functions const, but the return values non-const:

  E& first() const {
...
  E& top() const {
...
  E& last() const {


I think there should be some consistency w.r.t. between all these functions.

-------------

PR Review: https://git.openjdk.org/jdk/pull/18975#pullrequestreview-2024923074