wrap_index.h

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef STDLIB_NDARRAY_BASE_WRAP_INDEX_H
#define STDLIB_NDARRAY_BASE_WRAP_INDEX_H

#include <stdint.h>

/*
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
*/
#ifdef __cplusplus
extern "C" {
#endif

/**
* Wraps an index on the interval `[0,max]`.
*/
int64_t stdlib_ndarray_wrap_index( int64_t idx, int64_t max );

#ifdef __cplusplus
}
#endif

#endif // !STDLIB_NDARRAY_BASE_WRAP_INDEX_H