Mimicking named arguments, a good idea? (programming style)

Question

With respect to code readability I like the possibility to use keyword (named) arguments.

I would like to have this under Mathematica, but AFAIK there is no native support for that.

By example, to define an inverse gamma distribution, I come with this approach:

createInverseGamma[Mean->m_,Variance->v_]:=
  With[{a=(m^2+2v)/v,b=m (m^2+v)/v},InverseGammaDistribution[a,b]];

createInverseGamma[Mean->m_,StandardDeviation->std_]:=
  createInverseGamma[Mean->m,Variance->std^2];

dist=createInverseGamma[Mean->1,StandardDeviation->2]

Mean[dist]             (* 1 *)
Variance[dist]         (* 4 *)

My question: do you see some drawbacks to this approach or do you have a better solution?

nb:

• clearly some symbols have to be reserved and protected (here I use Mean, Variance etc... that are already defined).
• this approach can interfere with Option, maybe it would be better to define something like foo[Mean=5] with "=" instead of ->

---

update:

here is an example with "=" instead of ->

SetAttributes[createInverseGamma,HoldAll];

createInverseGamma[Mean=m_,Variance=v_]:=
  With[{a=(m^2+2v)/v,b=m (m^2+v)/v},InverseGammaDistribution[a,b]];

createInverseGamma[Mean=m_,StandardDeviation=std_]:=
  createInverseGamma[Mean=m,Variance=std^2];

dist=createInverseGamma[Mean=1,StandardDeviation=2]

Mean[dist]             (* 1 *)
Variance[dist]         (* 4 *)

However I am even less sure that it has no deleterious side effect...?

Answer 1

I was recently inspired by ES6 object desctructuring and made something that fits your needs.

It is part of https://github.com/kubaPod/Meh and I consider it beta but I don't care about proper prerelease since I have zero feedback anyway :)

(* ResourceFunction["GitHubInstall"]["kubapod", "meh"] *)

<< Meh`

ClearAll[foo]
foo//es6Decorate
foo[<|
         a_,
         b_Integer,
  "F" -> f_,
         g_:10,
  "J" -> j_:1
|>
]:={a,b,f,g,j}

foo@<|"b"->2,"a"->1,"F"->3|>
foo@<|"b"->2,"a"->1,"F"->3,"g"->100|>
foo@<|"b"->2.2,"a"->1,"F"->3|>

{1, 2, 3, 10, 1}

{1, 2, 3, 100, 1}

foo[<|"b" -> 2.2, "a" -> 1, "F" -> 3|>]

which seems to support what you need because you can do:

createInverseGamma // es6Decorate

createInverseGamma[<|"Mean" -> m_, "Variance" -> v_|>] := With[
  {a = (m^2 + 2 v)/v, b = m (m^2 + v)/v}
, InverseGammaDistribution[a, b]
];

createInverseGamma[<|"Mean" -> m_, "StandardDeviation" -> std_|>] := 
  createInverseGamma[<|"Mean" -> m, "Variance" -> std^2|>];

dist = createInverseGamma[<|"Mean" -> 1, "StandardDeviation" -> 2|>]

Mean[dist]             (*1*)
Variance[dist]         (*4*)

So yes, not exactly the same syntax but this answer is a side effect.