efi_interpolation.h File Reference

Detailed Description

See also libfirmware interpolation.h

Date

Oct 17, 2013

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file efi_interpolation.h.

Functions
float	interpolateClampedWithValidation (float x1, float y1, float x2, float y2, float x)
float	interpolateClamped (float x1, float y1, float x2, float y2, float x)
float	interpolateMsg (const char *msg, float x1, float y1, float x2, float y2, float x)
	Linear interpolation by two points.
template<typename TValue , int TSize>
void	ensureArrayIsAscending (const char *msg, const TValue(&values)[TSize])
template<typename TValue , int TSize>
void	ensureArrayIsAscendingOrDefault (const char *msg, const TValue(&values)[TSize])
template<typename kType >
int	findIndexMsg (const char *msg, const kType array[], int size, kType value)
	Binary search.
template<typename VType , typename kType >
void	setCurveValue (const kType bins[], VType values[], int size, float key, float value)

Function Documentation

ensureArrayIsAscending()

template<typename TValue , int TSize>

void ensureArrayIsAscending	(	const char *	msg,
		const TValue(&)	values[TSize]
	)

Definition at line 32 of file efi_interpolation.h.

                                                                            {
    for (size_t i = 0; i < TSize - 1; i++) {
        float cur = values[i];
        float next = values[i + 1];
        if (next <= cur) {
            firmwareError(ObdCode::CUSTOM_ERR_AXIS_ORDER, "Invalid table axis (must be ascending!): %s %f should be below %f at %d", msg, cur, next, i);
        }
    }
}

Referenced by ensureArrayIsAscendingOrDefault(), and validateConfigOnStartUpOrBurn().

Here is the call graph for this function:

Here is the caller graph for this function:

ensureArrayIsAscendingOrDefault()

template<typename TValue , int TSize>

void ensureArrayIsAscendingOrDefault	(	const char *	msg,
		const TValue(&)	values[TSize]
	)

Definition at line 43 of file efi_interpolation.h.

                                                                                     {
    if (values[1] == 0) {
        return; // looks like default empty array, do not check
    }
    ensureArrayIsAscending(msg, values);
}

Referenced by validateConfigOnStartUpOrBurn().

Here is the call graph for this function:

Here is the caller graph for this function:

findIndexMsg()

template<typename kType >

int findIndexMsg	(	const char *	msg,
		const kType	array[],
		int	size,
		kType	value
	)

Binary search.

Returns

the highest index within sorted array such that array[i] is greater than or equal to the parameter

Note

If the parameter is smaller than the first element of the array, -1 is returned.

See also ensureArrayIsAscending

Definition at line 57 of file efi_interpolation.h.

                                                                              {
    float fvalue = (float)value;
    if (std::isnan(fvalue)) {
        firmwareError(ObdCode::ERROR_NAN_FIND_INDEX, "NaN in findIndex%s", msg);
        return 0;
    }
 
    if (value < array[0])
        return -1;
    int middle;
 
    int left = 0;
    int right = size;
 
    // todo: extract binary search as template method?
    while (true) {
#if 0
        // that's an assertion to make sure we do not loop here
        size--;
        efiAssert(ObdCode::CUSTOM_ERR_ASSERT, size > 0, "Unexpected state in binary search", 0);
#endif
 
        // todo: compare current implementation with
        // http://eigenjoy.com/2011/01/21/worlds-fastest-binary-search/
        // ?
        middle = (left + right) / 2;
 
//      print("left=%d middle=%d right=%d: %.2f\r\n", left, middle, right, array[middle]);
 
        if (middle == left)
            break;
 
        if (middle != 0 && array[middle - 1] > array[middle]) {
#if EFI_UNIT_TEST
            firmwareError(ObdCode::CUSTOM_ERR_6610, "%s: out of order %.2f %.2f", msg, array[middle - 1], array[middle]);
#else
            warning(ObdCode::CUSTOM_ERR_OUT_OF_ORDER, "%s: out of order %.2f %.2f", msg, array[middle - 1], array[middle]);
 
#endif /* EFI_UNIT_TEST */
        }
 
        if (value < array[middle]) {
            right = middle;
        } else if (value > array[middle]) {
            left = middle;
        } else {
            break;
        }
    }
 
    return middle;
}

Referenced by setCurveValue().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolateClamped()

float interpolateClamped	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	x
	)

todo: use 'interpolateClampedWithValidation' wider?

See also

interpolateMsg

Definition at line 69 of file interpolation.cpp.

                                                                          {
    // note how we assume order of x1 and x2 here! see also interpolateClampedWithValidation
    if (x <= x1)
        return y1;
    if (x >= x2)
        return y2;
 
    // todo: do we care with code duplication with interpolateMsg above?
    float a = INTERPOLATION_A(x1, y1, x2, y2);
    float b = y1 - a * x1;
    return a * x + b;
}

Referenced by LaunchControlBase::calculateSparkSkipRatio(), ThrottleModelBase::estimateThrottleFlow(), flexCallback(), IdleController::getClosedLoop(), getCrankingAdvance(), getCrankingFuel3(), IdleController::getIdleTimingAdjustment(), IdleController::getOpenLoop(), getRunningAdvance(), IdleController::getRunningOpenLoop(), EtbController::getSetpointEtb(), FuelComputer::getStoichiometricRatio(), IdleController::getTargetRpm(), IFuelComputer::getTCharge(), IFuelComputer::getTChargeCoefficient(), DfcoController::getTimingRetard(), AirmassVeModelBase::getVe(), interpolateClampedWithValidation(), HellaOilLevelSensor::onEdge(), setHysteresis(), LimpManager::updateRevLimit(), and updateVrThresholdPwm().

Here is the caller graph for this function:

interpolateClampedWithValidation()

float interpolateClampedWithValidation	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	x
	)

Definition at line 58 of file interpolation.cpp.

                                                                                        {
    if (x1 >= x2) {
        criticalError("interpolateClamped %f has to be smaller than %f", x1, x2);
    }
    return interpolateClamped(x1, y1, x2, y2, x);
}

Here is the call graph for this function:

interpolateMsg()

float interpolateMsg	(	const char *	msg,
		float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	x
	)

Linear interpolation by two points.

Parameters

x1	key of the first point
y1	value of the first point
x2	key of the second point
y2	value of the second point
X	key to be interpolated

Note

For example, "interpolateMsg("", engineConfiguration.tpsMin, 0, engineConfiguration.tpsMax, 100, adc);"

See also

interpolateClamped

we could end up here for example while resetting bins while changing engine type

Definition at line 28 of file interpolation.cpp.

                                                                                       {
    if (std::isnan(x1) || std::isnan(x2) || std::isnan(y1) || std::isnan(y2)) {
        warning(ObdCode::CUSTOM_ERR_INTERPOLATE_1, "interpolate%s: why param", msg);
        return NAN;
    }
    if (std::isnan(x)) {
        warning(ObdCode::CUSTOM_ERR_INTERPOLATE_2, "interpolate%s: why X", msg);
        return NAN;
    }
    // todo: double comparison using EPS
    if (x1 == x2) {
        /**
         * we could end up here for example while resetting bins while changing engine type
         */
        warning(ObdCode::CUSTOM_ERR_INTERPOLATE_3, "interpolate%s: Same x1 and x2 in interpolate: %.2f/%.2f", msg, x1, x2);
        return NAN;
    }
 
    // a*x1 + b = y1
    // a*x2 + b = y2
//  efiAssertVoid(ObdCode::CUSTOM_ERR_ASSERT_VOID, x1 != x2, "no way we can interpolate");
    float a = INTERPOLATION_A(x1, y1, x2, y2);
    if (std::isnan(a)) {
        warning(ObdCode::CUSTOM_ERR_INTERPOLATE_4, "interpolate%s: why a", msg);
        return NAN;
    }
    float b = y1 - a * x1;
    return a * x + b;
}

Referenced by decodeTpsSentValue(), getAdvanceForRpm(), getAfr(), IFuelComputer::getTChargeCoefficient(), lua_interpolate(), and setLinearCurve().

Here is the call graph for this function:

Here is the caller graph for this function:

setCurveValue()

template<typename VType , typename kType >

void setCurveValue	(	const kType	bins[],
		VType	values[],
		int	size,
		float	key,
		float	value
	)

Sets specified value for specified key in a correction curve see also setLinearCurve()

Definition at line 115 of file efi_interpolation.h.

                                                                                         {
    int index = findIndexMsg("tbVl", bins, size, key);
    if (index == -1)
        index = 0;
    values[index] = value;
}

Here is the call graph for this function:

Go to the source code of this file.