Skip to content

Improve comments, function & class documentation in IndexOfRightMostSetBit.java #5579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
package com.thealgorithms.bitmanipulation;

/**
* Find The Index Of Right Most SetBit
* @author Bama Charan Chhandogi (https://github.com/BamaCharanChhandogi)
* Utility class for bit manipulation operations.
* This class provides methods to work with bitwise operations.
* Specifically, it includes a method to find the index of the rightmost set bit
* in an integer.
* This class is not meant to be instantiated.
*
* Author: Bama Charan Chhandogi (https://github.com/BamaCharanChhandogi)
*/

public final class IndexOfRightMostSetBit {

private IndexOfRightMostSetBit() {
}

/**
* Finds the index of the rightmost set bit in the given integer.
* The index is zero-based, meaning the rightmost bit has an index of 0.
*
* @param n the integer to check for the rightmost set bit
* @return the index of the rightmost set bit; -1 if there are no set bits
* (i.e., the input integer is 0)
*/
public static int indexOfRightMostSetBit(int n) {
if (n == 0) {
return -1; // No set bits
Expand All @@ -16,7 +30,7 @@ public static int indexOfRightMostSetBit(int n) {
// Handle negative numbers by finding the two's complement
if (n < 0) {
n = -n;
n = n & (~n + 1); // Get the rightmost set bit in positive form
n = n & (~n + 1); // Isolate the rightmost set bit
}

int index = 0;
Expand Down