Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:124108
Feedback-ID: ifab94697:Fastmail
User-Agent: Cyrus-JMAP/3.11.0-alpha0-538-g1508afaa2-fm-20240616.001-g1508afaa
Precedence: bulk
MIME-Version: 1.0
Message-ID: <870bb837-400c-4a86-ab49-2ffef9d80ce7@app.fastmail.com>
In-Reply-To: <3B23E039-D90F-4F84-9ECE-C6A9A3E145AF@sakiot.com>
References: <F709ADD3-502E-418B-82D3-34A681EBB7A0@sakiot.com>
 <668168A7.4040005@adviesenzo.nl>
 <e4a3fba1-e441-4f35-ac17-462f5f9c3fb9@app.fastmail.com>
 <3B23E039-D90F-4F84-9ECE-C6A9A3E145AF@sakiot.com>
Date: Sun, 30 Jun 2024 17:31:57 +0200
To: "Saki Takamachi" <saki@sakiot.com>
Cc: internals@lists.php.net
Subject: Re: [PHP-DEV] [RFC] [Discussion] Add bcdivmod to BCMath
Content-Type: multipart/alternative;
 boundary=2d5a8ea9d3c84a87a7380d52226e561c
From: rob@bottled.codes ("Rob Landers")

--2d5a8ea9d3c84a87a7380d52226e561c
Content-Type: text/plain;charset=utf-8
Content-Transfer-Encoding: quoted-printable



On Sun, Jun 30, 2024, at 17:11, Saki Takamachi wrote:
> Hi,
>=20
> >> Just a suggestion: what about making the returned array an associat=
ive
> >> array ? Like so:
> >> ```
> >> array(
> >>      'quotient' =3D> 61,
> >>      'remainder' =3D> 1,
> >> );
> >> ```
> >> This would remove the need for devs to remember the order of the re=
turn
> >> values and would make the return value self-documenting.
> >=20
> > An associative array would combine the worst of an array (no IDE aut=
ocompletion, no strong typing, increased memory usage) with the worst of=
 an object (no easy way to extract the values into local variables with =
array destructuring).
> >=20
> > The example in the RFC doesn't show it, but the following makes the =
proposed API really convenient to use:
> >=20
> >    $slicesOfPizza =3D new BcMath\Number(8);
> >    $mouthsToFeed =3D new BcMath\Number(3);
> >    [$perMouth, $slicesLeft] =3D $slicesOfPizza->divmod($mouthsToFeed=
);
> >=20
> > Note how the order of values matches the words in the method name. F=
irst the result of 'div', then the result of 'mod=E2=80=99.
>=20
>=20
> Thanks, I have added this example to the RFC (Please let me know if yo=
u have any problems).
>=20
>=20
> > I came here to say the same thing. The best solution would be not ha=
ving to refer to documentation or experiment with values, and this hits =
the nail on the head.
> >=20
> > The only thing that makes it weird is having to write it out, which =
at that point, it is probably faster to type out bcdiv and bcmod separat=
ely.
> >=20
> > Have you considered simply using references passed to the function? =
I feel like that is more idiomatically php.
>=20
> Of course, that idea was proposed, but it was pointed out that current=
 PHP tends to avoid such implementations, so we didn't adopt it. The rea=
son why passing by reference was not adopted was added to the RFC.
>=20
> Regards,
>=20
> Saki

I guess it could go either way:

returns by structured array examples:

- getimagesize()
- parse_url()
- pathinfo()
- stat()
- posix_getpwuid()

and then these by reference:

- list() -- kinda
- array_shift(), array_pop(), etc.
- preg_match*()
- all the sorts

Just thinking through it, return by reference is much more common in PHP=
 than returning structured arrays, and the ones that do make a ton of se=
nse that they do (lots of data).

=E2=80=94 Rob
--2d5a8ea9d3c84a87a7380d52226e561c
Content-Type: text/html;charset=utf-8
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE html><html><head><title></title><style type=3D"text/css">p.Mso=
Normal,p.MsoNoSpacing{margin:0}</style></head><body><div><br></div><div>=
<br></div><div>On Sun, Jun 30, 2024, at 17:11, Saki Takamachi wrote:<br>=
</div><blockquote type=3D"cite" id=3D"qt" style=3D""><div>Hi,<br></div><=
div><br></div><div>&gt;&gt; Just a suggestion: what about making the ret=
urned array an associative<br></div><div>&gt;&gt; array ? Like so:<br></=
div><div>&gt;&gt; ```<br></div><div>&gt;&gt; array(<br></div><div>&gt;&g=
t;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'quotient' =3D&gt; 61,<br></div><div>&g=
t;&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'remainder' =3D&gt; 1,<br></div><di=
v>&gt;&gt; );<br></div><div>&gt;&gt; ```<br></div><div>&gt;&gt; This wou=
ld remove the need for devs to remember the order of the return<br></div=
><div>&gt;&gt; values and would make the return value self-documenting.<=
br></div><div>&gt;&nbsp;<br></div><div>&gt; An associative array would c=
ombine the worst of an array (no IDE autocompletion, no strong typing, i=
ncreased memory usage) with the worst of an object (no easy way to extra=
ct the values into local variables with array destructuring).<br></div><=
div>&gt;&nbsp;<br></div><div>&gt; The example in the RFC doesn't show it=
, but the following makes the proposed API really convenient to use:<br>=
</div><div>&gt;&nbsp;<br></div><div>&gt;&nbsp;&nbsp;&nbsp; $slicesOfPizz=
a =3D new BcMath\Number(8);<br></div><div>&gt;&nbsp;&nbsp;&nbsp; $mouths=
ToFeed =3D new BcMath\Number(3);<br></div><div>&gt;&nbsp;&nbsp;&nbsp; [$=
perMouth, $slicesLeft] =3D $slicesOfPizza-&gt;divmod($mouthsToFeed);<br>=
</div><div>&gt;&nbsp;<br></div><div>&gt; Note how the order of values ma=
tches the words in the method name. First the result of 'div', then the =
result of 'mod=E2=80=99.<br></div><div><br></div><div><br></div><div>Tha=
nks, I have added this example to the RFC (Please let me know if you hav=
e any problems).<br></div><div><br></div><div><br></div><div>&gt; I came=
 here to say the same thing. The best solution would be not having to re=
fer to documentation or experiment with values, and this hits the nail o=
n the head.<br></div><div>&gt;&nbsp;<br></div><div>&gt; The only thing t=
hat makes it weird is having to write it out, which at that point, it is=
 probably faster to type out bcdiv and bcmod separately.<br></div><div>&=
gt;&nbsp;<br></div><div>&gt; Have you considered simply using references=
 passed to the function? I feel like that is more idiomatically php.<br>=
</div><div><br></div><div>Of course, that idea was proposed, but it was =
pointed out that current PHP tends to avoid such implementations, so we =
didn't adopt it. The reason why passing by reference was not adopted was=
 added to the RFC.<br></div><div><br></div><div>Regards,<br></div><div><=
br></div><div>Saki<br></div></blockquote><div><br></div><div>I guess it =
could go either way:<br></div><div><br></div><div>returns by structured =
array examples:<br></div><div><br></div><div>- getimagesize()<br></div><=
div>- parse_url()<br></div><div>- pathinfo()<br></div><div>- stat()<br><=
/div><div>-&nbsp;posix_getpwuid()<br></div><div><br></div><div>and then =
these by reference:<br></div><div><br></div><div>- list() -- kinda<br></=
div><div>- array_shift(), array_pop(), etc.<br></div><div>- preg_match*(=
)<br></div><div>- all the sorts<br></div><div><br></div><div>Just thinki=
ng through it, return by reference is much more common in PHP than retur=
ning structured arrays, and the ones that do make a ton of sense that th=
ey do (lots of data).</div><div><br></div><div id=3D"sig121229152">=E2=80=
=94 Rob<br></div></body></html>
--2d5a8ea9d3c84a87a7380d52226e561c--