import type { NumberArray } from 'cheminfo-types';

/**
 * This function performs a circular shift to an array.
 * Positive values of shifts will shift to the right and negative values will do to the left.
 * @example xRotate([1,2,3,4],1) -> [4,1,2,3]
 * @example xRotate([1,2,3,4],-1) -> [2,3,4,1]
 * @param array - array
 * @param shift - shift
 * @returns - rotated array
 */
export function xRotate(
  array: NumberArray,
  shift: number,
): Float64Array<ArrayBuffer> {
  shift = shift % array.length;
  if (shift < 0) shift += array.length;
  const result = new Float64Array(array.length);
  result.set(array.slice(array.length - shift));
  result.set(array.slice(0, array.length - shift), shift);
  return result;
}