Sorting in scala using sorted,sortBy and sortWith function

Table of contents

Reading Time: 4 minutes

Sorting is arranging the data in ascending or descending order. Sorted data helps us searching easily. In mobile phone contacts are sorted in the alphabetic order it helps us to find easily a mobile number of any people.
Scala usesTimSort, which is a hybrid of Merge Sort and Insertion Sort.
Here is three sorting method of Scala.

sorted

Here is signature

def sorted[B >: A](implicit ord: Ordering[B]): Repr

The sorted function is used to sort the sequence in Scala like (List, Array, Vector, Seq). The sorted function returns new Collection which is sorted by their natural order.

Now, Here is a small example Sorted with Seq

scala> val seq = Seq(12,3,78,90,1)
seq: Seq[Int] = List(12, 3, 78, 90, 1)

scala> seq.sorted

res4: Seq[Int] = List(1, 3, 12, 78, 90)

If you want to sort in descending order then, use this signature Seq.sorted(Ordering.DataType.reverse)

scala> val seq = Seq(12,3,78,90,1)
seq: Seq[Int] = List(12, 3, 78, 90, 1)

scala> seq.sorted(Ordering.Int.reverse)
res6: Seq[Int] = List(90, 78, 12, 3, 1)

If you want to sort on the basis of an attribute of a case class using sorted method, then you need to extend Ordered trait and override abstract method compare. In compare method, we define on which attribute we want to sort the objects of case class.
here is an example
sort on the basis of the name attribute of the case class.

scala> case class Emp(id: Int,name: String,salary: Double) extends Ordered[Emp] {
| def compare(that: Emp) = this.name compare that.name
| }
defined class Emp

scala> val firstEmp = Emp(1, "michael", 12000.00)
firstEmp: Emp = Emp(1,michael,12000.0)

scala> val secondEmp = Emp(2, "james", 12000.00)
secondEmp: Emp = Emp(2,james,12000.0)

scala> val thirdEmp = Emp(3, "shaun", 12000.00)
thirdEmp: Emp = Emp(3,shaun,12000.0)

scala> val empList = List(firstEmp,secondEmp,thirdEmp)
empList: List[Emp] = List(Emp(1,michael,12000.0), Emp(2,james,12000.0), Emp(3,shaun,12000.0))

scala> empList.sorted
res0: List[Emp] = List(Emp(2,james,12000.0), Emp(1,michael,12000.0), Emp(3,shaun,12000.0))

If you do not extend Ordered trait and want to sort a case class attribute then the compiler does not know in which attribute basis it will sort so it will give a compile-time error.
here is an example.

scala> case class Emp(id: Int, name: String, salary: Double)
defined class Emp

scala> val firstEmp = Emp(1,"james",12000.00)
firstEmp: Emp = Emp(1,james,12000.0)

scala> val secondEmp = Emp(2,"shaun",12000.00)
secondEmp: Emp = Emp(2,shaun,12000.0)

scala> val thirdEmp = Emp(3,"michael",12000.00)
thirdEmp: Emp = Emp(3,michael,12000.0)

scala> val empList = List(firstEmp,secondEmp,thirdEmp)
empList: List[Emp] = List(Emp(1,james,12000.0), Emp(2,shaun,12000.0), Emp(3,michael,12000.0))

scala> empList.sorted
:13: error: No implicit Ordering defined for Emp.
empList.sorted

sortBy(attribute)

Here is signature

def sortBy[B](f: A => B)(implicit ord: Ordering[B]): Repr

The sortBy function is used to sort one or more attributes.
Here is a small example.
sort based on a single attribute of the case class.

scala> case class Emp(id: Int, name: String, salary: Double)
defined class Emp

scala> val firstEmp = Emp(1,"james",12000.00)
firstEmp: Emp = Emp(1,james,12000.0)

scala> val secondEmp = Emp(2,"shaun",12000.00)
secondEmp: Emp = Emp(2,shaun,12000.0)

scala> val thirdEmp = Emp(3,"michael",12000.00)
thirdEmp: Emp = Emp(3,michael,12000.0)

scala> val forthEmp = Emp(4,"michael",11000.00)
forthEmp: Emp = Emp(4,michael,11000.0)

scala> val fifthEmp = Emp(5,"michael",15000.00)
fifthEmp: Emp = Emp(5,michael,15000.0)

scala> val empList = List(firstEmp,secondEmp,thirdEmp,forthEmp,fifthEmp)
empList: List[Emp] = List(Emp(1,james,12000.0), Emp(2,shaun,12000.0), Emp(3,michael,12000.0), Emp(4,michael,11000.0), Emp(5,michael,15000.0))

scala> empList.sortBy(_.name)
res0: List[Emp] = List(Emp(1,james,12000.0), Emp(3,michael,12000.0), Emp(4,michael,11000.0), Emp(5,michael,15000.0), Emp(2,shaun,12000.0))

sort in descending by salary

scala> empList.sortBy(_.salary)(Ordering[Double].reverse)
res1: List[Emp] = List(Emp(5,michael,15000.0), Emp(1,james,12000.0), Emp(2,shaun,12000.0), Emp(3,michael,12000.0), Emp(4,michael,11000.0))

sort is based on multiple attributes, it will sort based on the first attribute if more than one value in the first attribute is same then it will sort on the basis of the second attribute and so on.

scala> empList.sortBy(empList =>(empList.name,empList.salary))
res2: List[Emp] = List(Emp(1,james,12000.0), Emp(4,michael,11000.0), Emp(3,michael,12000.0), Emp(5,michael,15000.0), Emp(2,shaun,12000.0))

sort list of a tuple by their second element using sortBy

scala> val list = List(('b',30),('c',10),('a',20))
list: List[(Char, Int)] = List((b,30), (c,10), (a,20))

scala> list.sortBy(_._2)
res3: List[(Char, Int)] = List((c,10), (a,20), (b,30))

similarly, we can sort list of a tuple by their first element


scala> list.sortBy(_._1)
res4: List[(Char, Int)] = List((a,20), (b,30), (c,10))

sortWith(function)

Here is signature

 def sortWith(lt: (A, A) => Boolean): Repr

The sortWith function Sorts this sequence according to a comparison function. it takes a comparator function and sort according to it.you can provide your own custom comparison function.

Here is a small example

scala> case class Emp(id: Int, name: String, salary: Double)
defined class Emp

scala> val emp1 = Emp(1, "james", 13000.00)
emp1: Emp = Emp(1,james,13000.0)

scala> val emp2 = Emp(2, "michael", 12000.00)
emp2: Emp = Emp(2,michael,12000.0)

scala> val emp3 = Emp(3, "shaun", 15000.00)
emp3: Emp = Emp(3,shaun,15000.0)

scala> val empList = List(emp1,emp2,emp3)
empList: List[Emp] = List(Emp(1,james,13000.0), Emp(2,michael,12000.0), Emp(3,shaun,15000.0))

// sort in descending order on the basis of salary.
scala> empList.sortWith(_.salary > _.salary)
res5: List[Emp] = List(Emp(3,shaun,15000.0), Emp(1,james,13000.0), Emp(2,michael,12000.0))

you can also sort by using own function.

scala> case class Emp(id: Int, name: String, salary: Double)
defined class Emp

scala> def sortBySalary(emp1 :Emp,emp2:Emp): Boolean =
| {
| emp1.salary < emp2.salary | } sortBySalary: (emp1: Emp, emp2: Emp)Boolean scala> val firstEmp = Emp(1, "james", 13000.00)
firstEmp: Emp = Emp(1,james,13000.0)

scala> val secondEmp = Emp(2, "michael", 12000.00)
secondEmp: Emp = Emp(2,michael,12000.0)

scala> val thirdEmp = Emp(3, "shaun", 15000.00)
thirdEmp: Emp = Emp(3,shaun,15000.0)

scala> val empList = List(firstEmp,secondEmp,thirdEmp)
empList: List[Emp] = List(Emp(1,james,13000.0), Emp(2,michael,12000.0), Emp(3,shaun,15000.0))

scala> val result = empList.sortWith((emp1,emp2) => sortBySalary(emp1,emp2))
result: List[Emp] = List(Emp(2,michael,12000.0), Emp(1,james,13000.0), Emp(3,shaun,15000.0))

Please comment, if you have any doubt or suggestion.
thank you 🙂

5 thoughts on “Sorting in scala using sorted,sortBy and sortWith function5 min read”

Ram Ghadiyaram says:

August 2, 2018 at 1:05 AM

Good explanation buddy. To compare, java Comparable and Comparator and Sorted, SortBy, SortWith…

SortWith is just like Comparator in this case AgeComparator or SalaryComparator etc… remaining to are Sorted and SortBy looks like Comparable(Ordering in case of scala)
Ram Ghadiyaram says:

August 2, 2018 at 1:15 AM

According to Java 7 API docs

Arrays#Sort() for object arrays now uses TimSort, which is a hybrid of MergeSort and InsertionSort.

On the other hand, Arrays#sort() for primitive arrays now uses Dual-PivotQuickSort.
randhir1910 says:

August 2, 2018 at 7:39 AM

Thanks for the comment, I agree with your points.
Pingback: Sorting Data In Scala – Curated SQL
Shreesha S says:

March 8, 2019 at 11:13 AM

Nice explaination, Thank you