time-to-botec

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

ramp.c (1090B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 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/math/base/special/ramp.h"
     20 #include "stdlib/math/base/assert/is_nan.h"
     21 
     22 /**
     23 * Evaluates the ramp function.
     24 *
     25 * @param x       number
     26 * @return        function value
     27 *
     28 * @example
     29 * double v = ramp( 3.14 );
     30 * // returns 3.14
     31 *
     32 * @example
     33 * double v = ramp( -3.14 );
     34 * // returns 0.0
     35 */
     36 double stdlib_base_ramp( const double x ) {
     37 	if ( stdlib_base_is_nan( x ) ) {
     38 		return 0.0 / 0.0; // NaN
     39 	}
     40 	if ( x > 0.0 ) {
     41 		return x;
     42 	}
     43 	return 0.0; // handles `-0`
     44 }