time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.c (1113B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 #include "stdlib/ndarray/base/clamp_index.h"
     20 #include <stdint.h>
     21 
     22 /**
     23 * Restricts an index to the interval `[0,max]`.
     24 *
     25 * @param idx  index
     26 * @param max  maximum index (should be nonnegative)
     27 * @return     index
     28 *
     29 * @example
     30 * #include "stdlib/ndarray/base/clamp_index.h"
     31 *
     32 * int64_t idx = stdlib_ndarray_clamp_index( 10, 8 );
     33 * // returns 8
     34 */
     35 int64_t stdlib_ndarray_clamp_index( int64_t idx, int64_t max ) {
     36 	if ( idx < 0 ) {
     37 		return 0;
     38 	}
     39 	if ( idx > max ) {
     40 		return max;
     41 	}
     42 	return idx;
     43 }