#include <table_helper.h>

Inheritance diagram for Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >:

Collaboration diagram for Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >:

[legend]

Public Member Functions
	Map3D (const char *name)

template<typename TValueInit , typename TXColumnInit , typename TRowInit >
void	initTable (TValueInit(&table)[TRowNum][TColNum], const TXColumnInit(&columnBins)[TColNum], const TRowInit(&rowBins)[TRowNum])

float	getValue (float xColumn, float yRow) const final

void	setAll (TValue value)

Private Member Functions
template<int TMult, int TDiv>
void	initValues (scaled_channel< TValue, TMult, TDiv >(&table)[TRowNum][TColNum])

void	initValues (TValue(&table)[TRowNum][TColNum])

template<int TRowMult, int TRowDiv>
void	initRows (const scaled_channel< TRow, TRowMult, TRowDiv >(&rowBins)[TRowNum])

void	initRows (const TRow(&rowBins)[TRowNum])

template<int TColMult, int TColDiv>
void	initCols (const scaled_channel< TXColumn, TColMult, TColDiv >(&columnBins)[TColNum])

void	initCols (const TXColumn(&columnBins)[TColNum])

TValue	getValueAtPosition (size_t row, size_t column) const

Static Private Member Functions
static size_t	getIndexForCoordinates (size_t row, size_t column)

Private Attributes
TValue(*	m_values )[TRowNum][TColNum] = nullptr

const TRow(*	m_rowBins )[TRowNum] = nullptr

const TXColumn(*	m_columnBins )[TColNum] = nullptr

float	m_rowMult = 1

float	m_colMult = 1

float	m_valueMult = 1

const char *	m_name

Detailed Description

template<int TColNum, int TRowNum, typename TValue, typename TXColumn, typename TRow>
class Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >

this helper class brings together 3D table with two 2D axis curves TODO: explicitly spell out why do we have this template and when exactly is it useful (useful with scaled content?) todo: improve interpolate3d to handle scaling? A recommended use is if a class depends on a table and this can be shared with several classes but only one is instantiated, see for example airmass.h It can also be used if you need to test the behavior of a calculated X/Y => table value, but it is advisable to do those expects externally and/or only test the result of the get, since interpotalate3d is easier to use and does not require initiation. *** WARNING *** https://en.wikipedia.org/wiki/KISS_principle *** WARNING *** this helper requires initialization, make sure that helper is useful any time you consider using it *** WARNING *** we had too many bugs where we were not initializing, often just using the underlying interpolate3d is the way to go

Definition at line 43 of file table_helper.h.

Constructor & Destructor Documentation

◆ Map3D()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::Map3D ( const char * name )

inline

Definition at line 45 of file table_helper.h.

                          {
    m_name = name;
  }

Member Function Documentation

◆ getIndexForCoordinates()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

static size_t Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getIndexForCoordinates	(	size_t	row,
		size_t	column
	)

inlinestaticprivate

Definition at line 115 of file table_helper.h.

                                                                    {
        // Index 0 is bottom left corner
        // Index TColNum - 1 is bottom right corner
        // indicies count right, then up
        return row * TColNum + column;
    }

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValueAtPosition().

Here is the caller graph for this function:

◆ getValue()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

float Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue	(	float	xColumn,
		float	yRow
	)		const

inlinefinalvirtual

Implements ValueProvider3D.

Definition at line 59 of file table_helper.h.

                                                          {
        if (!m_values) {
            criticalError("Access to uninitialized table: %s", m_name);
            return 0;
        }
 
        return interpolate3d(*m_values,
                                *m_rowBins, yRow * m_rowMult,
                                *m_columnBins, xColumn * m_colMult) *
            m_valueMult;
    }

◆ getValueAtPosition()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

TValue Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValueAtPosition	(	size_t	row,
		size_t	column
	)		const

inlineprivate

Definition at line 122 of file table_helper.h.

                                                               {
        auto idx = getIndexForCoordinates(row, column);
        return m_values[idx];
    }

Here is the call graph for this function:

◆ initCols() [1/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

template<int TColMult, int TColDiv>

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols ( const scaled_channel< TXColumn, TColMult, TColDiv >(&) columnBins[TColNum] )

inlineprivate

Definition at line 105 of file table_helper.h.

                                                                                            {
        m_columnBins = reinterpret_cast<const TXColumn (*)[TColNum]>(&columnBins);
        m_colMult = efi::ratio<TColMult, TColDiv>::asFloat();
    }

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCols() [2/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols ( const TXColumn(&) columnBins[TColNum] )

inlineprivate

Definition at line 110 of file table_helper.h.

                                                         {
        m_columnBins = &columnBins;
        m_colMult = 1;
    }

◆ initRows() [1/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

template<int TRowMult, int TRowDiv>

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows ( const scaled_channel< TRow, TRowMult, TRowDiv >(&) rowBins[TRowNum] )

inlineprivate

Definition at line 94 of file table_helper.h.

                                                                                     {
        m_rowBins = reinterpret_cast<const TRow (*)[TRowNum]>(&rowBins);
        m_rowMult = efi::ratio<TRowMult, TRowDiv>::asFloat();
    }

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRows() [2/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows ( const TRow(&) rowBins[TRowNum] )

inlineprivate

Definition at line 99 of file table_helper.h.

                                                  {
        m_rowBins = &rowBins;
        m_rowMult = 1;
    }

◆ initTable()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

template<typename TValueInit , typename TXColumnInit , typename TRowInit >

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initTable	(	TValueInit(&)	table[TRowNum][TColNum],
		const TXColumnInit(&)	columnBins[TColNum],
		const TRowInit(&)	rowBins[TRowNum]
	)

inline

Definition at line 49 of file table_helper.h.

                                                                                                 {
        // This splits out here so that we don't need one overload of init per possible combination of table/rows/columns types/dimensions
        // Overload resolution figures out the correct versions of the functions below to call, some of which have assertions about what's allowed
        initValues(table);
        initRows(rowBins);
        initCols(columnBins);
    }

Referenced by initElectronicThrottle(), initFuelMap(), initGpPwm(), initScriptImpl(), initSpeedDensity(), and initVvtActuators().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initValues() [1/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

template<int TMult, int TDiv>

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues ( scaled_channel< TValue, TMult, TDiv >(&) table[TRowNum][TColNum] )

inlineprivate

Definition at line 83 of file table_helper.h.

                                                                                    {
        m_values = reinterpret_cast<TValue (*)[TRowNum][TColNum]>(&table);
        m_valueMult = 1 / efi::ratio<TMult, TDiv>::asFloat();
    }

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initValues() [2/2]

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues ( TValue(&) table[TRowNum][TColNum] )

inlineprivate

Definition at line 88 of file table_helper.h.

                                                       {
        m_values = &table;
        m_valueMult = 1;
    }

◆ setAll()

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

void Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::setAll ( TValue value )

inline

Definition at line 71 of file table_helper.h.

                              {
        efiAssertVoid(ObdCode::CUSTOM_ERR_6573, m_values, "map not initialized");
 
        for (size_t r = 0; r < TRowNum; r++) {
            for (size_t c = 0; c < TColNum; c++) {
                (*m_values)[r][c] = value / m_valueMult;
            }
        }
    }

Field Documentation

◆ m_colMult

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

float Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_colMult = 1

private

Definition at line 134 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols().

◆ m_columnBins

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

const TXColumn(* Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_columnBins)[TColNum] = nullptr

private

Definition at line 131 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initCols().

◆ m_name

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

const char* Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_name

private

Definition at line 136 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::Map3D().

◆ m_rowBins

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

const TRow(* Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_rowBins)[TRowNum] = nullptr

private

Definition at line 130 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows().

◆ m_rowMult

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

float Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_rowMult = 1

private

Definition at line 133 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initRows().

◆ m_valueMult

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

float Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_valueMult = 1

private

Definition at line 135 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::setAll().

◆ m_values

template<int TColNum, int TRowNum, typename TValue , typename TXColumn , typename TRow >

TValue(* Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::m_values)[TRowNum][TColNum] = nullptr

private

Definition at line 128 of file table_helper.h.

Referenced by Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValue(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::getValueAtPosition(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues(), Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::initValues(), and Map3D< TColNum, TRowNum, TValue, TXColumn, TRow >::setAll().

The documentation for this class was generated from the following file:

util/containers/table_helper.h

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Map3D()

Member Function Documentation

◆ getIndexForCoordinates()

◆ getValue()

◆ getValueAtPosition()

◆ initCols() [1/2]

◆ initCols() [2/2]

◆ initRows() [1/2]

◆ initRows() [2/2]

◆ initTable()

◆ initValues() [1/2]

◆ initValues() [2/2]

◆ setAll()

Field Documentation

◆ m_colMult

◆ m_columnBins

◆ m_name

◆ m_rowBins

◆ m_rowMult

◆ m_valueMult

◆ m_values