Scala: Setting default argument for function parameter
Yesterday I wrote about a problem we’ve been having with trying to work out how to default a function parameter that we have in one of our methods.
Our current version of the code defines the function parameter as implicit which means that if it isn’t passed in it defaults to http://www.scala-lang.org/api/current/index.html#scala.Predef$$$less$colon$less:
def foo[T](bar: String)(implicit blah:(String => T)) = {
println(blah(bar));
bar
}
It’s not entirely clear just from reading the code where the implicit value is coming from so we want to try and make the code a bit more expressive.
The way we wanted to do this was by making 'blah' have a default value rather than making it implicit.
Our equivalent to Predef.conforms() is the http://stackoverflow.com/questions/1797502/is-there-a-scala-identity-function function and our first attempt at defaulting the parameter looked like this:
def foo[T](bar: String, blah:(String => T) = identity _) = {
println(blah(bar));
bar
}
Unfortunately when we try to use that function without providing the second argument we get the following exception:
scala> foo("mark")
<console>:18: error: polymorphic expression cannot be instantiated to expected type;
found : [T](Nothing) => Nothing
required: (String) => ?
Error occurred in an application involving default arguments.
foo("mark")
From what I understand the compiler is unable to infer the type of the input parameter, a problem we can fix by explicitly specifying that:
def foo[T](bar: String, blah:(String => T) = identity[String] _) = { println(blah(bar)); bar }
We can then either choose to provide a function:
scala> foo("mark", _ + "needham")
markneedham
res17: String = mark
…or not:
scala> foo("mark")
mark
res16: String = mark
This solves the problem for this simple example but an interesting problem that we then ran into is that we actually had overloaded versions of the method in question and only one overload is allowed to specify default arguments as per the spec.
Each overload actually takes in different parameter types so one way to get around this problem would be to make some of the parameters optional and then default them to None.
At the moment we’ve ended up leaving the implicit conversion in because the change is a bit bigger in nature than antiticpated.
About the author
I'm currently working on short form content at ClickHouse. I publish short 5 minute videos showing how to solve data problems on YouTube @LearnDataWithMark. I previously worked on graph analytics at Neo4j, where I also co-authored the O'Reilly Graph Algorithms Book with Amy Hodler.