What is the Long.signum function in Java?

The static signum function of the Long class is used to get the signum function of the specified long value.

The signum denotes the sign of a real number.

  • A real number less than zero is denoted by -1.
  • A real number greater than zero is denoted by 1.
  • A real number equal to zero is denoted by 0.

Syntax

The following is the function prototype:

public static int signum(long i)

Argument

This method takes a long value as an argument.

Return value

This method returns:

  • 1 if the argument is greater than zero.

  • -1 if the argument is less than zero.

  • 0 if the argument is equal to zero.

Code

The example below uses the signum function.

class LongSignumExample {
public static void main(String[] args) {
System.out.println("Signum for -10l is " + Long.signum(-10l));
System.out.println("Signum for 10l is " + Long.signum(10l));
System.out.println("Signum for 0 is " + Long.signum(0));
}
}

Explanation

In the code above:

  • In line 3, we called Long.signum(-10l). This will return -1 because the argument(-10l) is less than zero.

  • In line 4, we called Long.signum(10l). This will return -1 because argument(10l) is greater than zero.

  • In line 5, we called Long.signum(0). This will return 0 because the argument is equal to zero.

Free Resources