io.github.palexdev.mfxcore.utils.GridUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation

Material Design/Modern components for JavaFX, now packed as a single Jar

There is a newer version: 11.26.0

/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
 *
 * MaterialFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX. If not, see .
 */

package io.github.palexdev.mfxcore.utils;

import io.github.palexdev.mfxcore.collections.Grid.Coordinates;

import java.util.function.BiFunction;

/**
 * A set of utilities for grids/matrices
 */
public class GridUtils {

	private GridUtils() {
	}

	/**
	 * Converts the given subscripts/coordinate to a linear index.
	 * 
	 * {@code index = row * nColumns + column}
	 *
	 * @param nColumns the number of columns of the grid
	 */
	public static int subToInd(int nColumns, int row, int column) {
		return row * nColumns + column;
	}

	/**
	 * Given the number of columns of the grid, converted the given index
	 * to the row index.
	 */
	public static int indToRow(int nColumns, int index) {
		return index / nColumns;
	}

	/**
	 * Given the number of columns of the grid, converted the given index
	 * to the column index.
	 */
	public static int indToCol(int nColumns, int index) {
		return index % nColumns;
	}

	/**
	 * Converts the given linear index to subscripts as a {@link Coordinates} object.
	 * The key is the rows number and the value is the columns number.
	 * 
	 * {@code rowIndex = index / columnsNum}
	 * {@code columnIndex = index % columnsNum}
	 *
	 * @param nColumns the number of columns of the grid
	 */
	public static Coordinates indToSub(int nColumns, int index) {
		return Coordinates.of(indToRow(nColumns, index), indToCol(nColumns, index));
	}

	/**
	 * Converts the given linear index to subscripts and uses them to return an object
	 * built using the given {@link BiFunction}.
	 * 
	 * {@code rowIndex = index / columnsNum}
	 * {@code columnIndex = index % columnsNum}
	 *
	 * @param nColumns the number of columns of the grid
	 */
	public static  T indToSub(int nColumns, int index, BiFunction supplier) {
		return supplier.apply(indToRow(nColumns, index), indToCol(nColumns, index));
	}
}