Operator overloading concept in Kotlin

Introduction

Operator overloading lets you use normal symbols like + or * with your own types. It makes your code easier to read and write.

When you create a class that represents numbers or math objects and want to add or multiply them easily.

When you want to compare two objects using <, >, == symbols naturally.

When you want to combine or modify objects using operators like +, -, or * instead of calling functions.

When you want your custom types to behave like built-in types in expressions.

When you want to make your code look clean and intuitive for others to understand.

Syntax

Kotlin

operator fun plus(other: ClassName): ClassName {
    // code to add this and other
    return result
}

The operator keyword tells Kotlin this function is for operator overloading.

You define functions with names like plus, minus, times to overload +, -, * respectively.

Examples

This lets you add two Point objects using the + operator.

Kotlin

operator fun plus(other: Point): Point {
    return Point(x + other.x, y + other.y)
}

This lets you multiply a Point by an integer using the * operator.

Kotlin

operator fun times(scale: Int): Point {
    return Point(x * scale, y * scale)
}

This lets you compare two Point objects using <, > operators.

Kotlin

operator fun compareTo(other: Point): Int {
    return this.x.compareTo(other.x)
}

Sample Program

This program creates a Point class with operator functions to add points and multiply by a number. It shows how to use + and * with Point objects.

Kotlin

data class Point(val x: Int, val y: Int) {
    operator fun plus(other: Point): Point {
        return Point(x + other.x, y + other.y)
    }

    operator fun times(scale: Int): Point {
        return Point(x * scale, y * scale)
    }
}

fun main() {
    val p1 = Point(2, 3)
    val p2 = Point(4, 5)
    val p3 = p1 + p2
    val p4 = p3 * 2
    println("p3 = $p3")
    println("p4 = $p4")
}

Important Notes

Only certain operators can be overloaded in Kotlin.

Operator functions must be marked with the operator keyword.

Overloading operators makes your code cleaner but use it only when it makes sense.

Summary

Operator overloading lets you use symbols like +, -, * with your own classes.

Use the operator keyword before functions like plus, times.

This makes your custom types easier and nicer to work with.

Practice

1. What does operator overloading in Kotlin allow you to do?

easy

A. Disable operators for certain classes

B. Change the meaning of built-in types like Int or String

C. Create new operators not available in Kotlin

D. Use standard operators like + or * with your own classes

Solution

1. Step 1: Understand operator overloading purpose

   Operator overloading lets you define how operators like + work with your own classes.

2. Step 2: Check options meaning

   Only Use standard operators like + or * with your own classes correctly states this ability. Options A, B, and C are incorrect because Kotlin does not let you change built-in types, create new operators, or disable operators this way.

3. Final Answer:

   Use standard operators like + or * with your own classes -> Option D

4. Quick Check:

   Operator overloading = Use operators with custom classes [OK]

Hint: Operator overloading means using +, * with your own classes [OK]

Common Mistakes:

• Thinking you can create new operators
• Believing it changes built-in types
• Confusing disabling operators with overloading

2. Which of the following is the correct syntax to overload the plus operator in a Kotlin class?

easy

A. operator fun plus(other: MyClass): MyClass { ... }

B. fun plus(other: MyClass): MyClass { ... }

C. override fun plus(other: MyClass): MyClass { ... }

D. fun operator plus(other: MyClass): MyClass { ... }

Solution

1. Step 1: Recall operator function syntax

   In Kotlin, to overload an operator, the function must be marked with the keyword operator before the function declaration.

2. Step 2: Analyze options

   operator fun plus(other: MyClass): MyClass { ... } correctly uses operator fun plus(...). fun plus(other: MyClass): MyClass { ... } misses the operator keyword, C wrongly uses override, and D has incorrect keyword order.

3. Final Answer:

   operator fun plus(other: MyClass): MyClass { ... } -> Option A

4. Quick Check:

   Operator keyword before function = Correct syntax [OK]

Hint: Always put 'operator' before function to overload operators [OK]

Common Mistakes:

• Omitting the 'operator' keyword
• Using 'override' instead of 'operator'
• Placing 'operator' after 'fun'

3. What will be the output of this Kotlin code?

data class Point(val x: Int, val y: Int) {
    operator fun plus(other: Point) = Point(x + other.x, y + other.y)
}

fun main() {
    val p1 = Point(1, 2)
    val p2 = Point(3, 4)
    val p3 = p1 + p2
    println(p3)
}

medium

A. Point(x=4, y=6)

B. p1 + p2

C. Compilation error

D. Point(4, 6)

Solution

1. Step 1: Understand operator plus function

   The plus operator adds the x and y values of two Point objects and returns a new Point with summed coordinates.

2. Step 2: Calculate the result of p1 + p2

   p1 has (1, 2), p2 has (3, 4). Adding gives (4, 6). Printing p3 calls data class's toString(), which outputs 'Point(x=4, y=6)'.

3. Final Answer:

   Point(x=4, y=6) -> Option A

4. Quick Check:

   p1 + p2 = Point(x=4, y=6) [OK]

Hint: Data class toString shows property names; sum coordinates [OK]

Common Mistakes:

• Expecting just coordinates without property names
• Thinking '+' prints expression instead of result
• Assuming compilation error without operator keyword

4. Identify the error in this Kotlin code that tries to overload the minus operator:

class Counter(var count: Int) {
    fun minus(other: Counter): Counter {
        return Counter(count - other.count)
    }
}

medium

A. Wrong return type; should be Int instead of Counter

B. Missing 'operator' keyword before the minus function

C. Function name should be 'operatorMinus' instead of 'minus'

D. Cannot overload minus operator for classes

Solution

1. Step 1: Check operator overloading syntax

   To overload an operator in Kotlin, the function must have the 'operator' keyword before its declaration.

2. Step 2: Analyze the code

   The minus function lacks the 'operator' keyword, so Kotlin won't treat it as operator overloading, causing errors when using '-'.

3. Final Answer:

   Missing 'operator' keyword before the minus function -> Option B

4. Quick Check:

   Operator functions need 'operator' keyword [OK]

Hint: Operator functions must start with 'operator' keyword [OK]

Common Mistakes:

• Forgetting the 'operator' keyword
• Changing function name incorrectly
• Assuming operator overloading is not allowed

5. Given this Kotlin class:

class Vector(val x: Int, val y: Int) {
    operator fun plus(other: Vector) = Vector(x + other.x, y + other.y)
    operator fun times(scalar: Int) = Vector(x * scalar, y * scalar)
}

What is the result of this expression?

val v1 = Vector(2, 3)
val v2 = Vector(1, 1)
val result = (v1 + v2) * 2
println("(${result.x}, ${result.y})")

hard

A. (3, 4)

B. (4, 6)

C. (6, 8)

D. Compilation error due to operator precedence

Solution

1. Step 1: Evaluate v1 + v2

   v1 is (2,3), v2 is (1,1). Adding gives Vector(3,4).

2. Step 2: Multiply the result by 2

   Vector(3,4) times 2 gives Vector(6,8).

3. Step 3: Print the result

   Printing prints (6, 8) as expected.

4. Final Answer:

   (6, 8) -> Option C

5. Quick Check:

   (v1 + v2) * 2 = (6, 8) [OK]

Hint: Evaluate plus first, then times; operator overloading respects precedence [OK]

Common Mistakes:

• Multiplying v2 by 2 instead of the sum
• Ignoring operator precedence
• Expecting compilation error