Interface ILib.IAcquire.ISearch
- Namespace
- Csra.Interfaces
- Assembly
- Csra.dll
The interface for the Search branch.
public interface ILib.IAcquire.ISearch
Methods
BinarySearch<Tout>(double, double, double, bool, Func<Site<double>, Site<Tout>>, Func<Tout, bool>, double)
Performs a floating point binary search between inFrom and inTo by executing
oneMeasurement at each step. Determines the input resulting in an output closest to the trip criteria's inflection point.
The number of steps executed equals log2((inTo -inFrom) / inMinDelta), rounded up
to the next integer. The search ends when the minimum delta is reached, the reported result lies within inMinDelta from
the ideal result, matching criteria's direction. If no transition was found, the method returns inNotFoundResult.
Site<double> BinarySearch<Tout>(double inFrom, double inTo, double inMinDelta, bool invertingLogic, Func<Site<double>, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, double inNotFoundResult)
Parameters
inFromdoubleThe lower boundary of the search range. Must be less than
inTo.inTodoubleThe upper boundary of the search range. Must be greater than
inFrominMinDeltadoubleThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolDetermines whether the logic is inverted.
falsemeans higher input values increase the likelihood of meeting the trip criteria.truemeans lower input values do.oneMeasurementFunc<Site<double>, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
inNotFoundResultdoubleThe return value for the case when the trip criteria was never found.
Returns
- Site<double>
The input value resulting in an output fulfilling the trip criteria and be closest to it's inflection point. The worst case deviation from the exact input is (
inMinDelta.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(double, double, double, bool, Func<Site<double>, Site<Tout>>, Func<Tout, bool>, double, out Site<Tout>)
Performs a floating point binary search between inFrom and inTo by executing
oneMeasurement at each step. Determines the input resulting in an output closest to the trip criteria's inflection point.
The number of steps executed equals log2((inTo -inFrom) / inMinDelta), rounded up
to the next integer. The search ends when the minimum delta is reached, the reported result lies within inMinDelta from
the ideal result, matching criteria's direction. Additionally provides the output value of the input step found. If no transition was found,
the method returns inNotFoundResult.
Site<double> BinarySearch<Tout>(double inFrom, double inTo, double inMinDelta, bool invertingLogic, Func<Site<double>, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, double inNotFoundResult, out Site<Tout> outResult)
Parameters
inFromdoubleThe lower boundary of the search range. Must be less than
inTo.inTodoubleThe upper boundary of the search range. Must be greater than
inFrominMinDeltadoubleThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolDetermines whether the logic is inverted.
falsemeans higher input values increase the likelihood of meeting the trip criteria.truemeans lower input values do.oneMeasurementFunc<Site<double>, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
inNotFoundResultdoubleThe return value for the case when the trip criteria was never found.
outResultSite<Tout>Output - contains the output value of the input found.
Returns
- Site<double>
The input value resulting in an output fulfilling the trip criteria and be closest to it's inflection point. The worst case deviation from the exact input is (
inMinDelta.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(double, double, double, bool, Func<Site<double>, Site<Tout>>, Tout)
Performs a floating point binary search between inFrom and inTo by executing
oneMeasurement at each step. Determines the input resulting in an output closest to the (numeric) target. The number of
steps executed equals log2((inTo - inFrom) / inMinDelta), rounded up to the next
integer. The search ends when the minimum delta is reached, the reported result lies within +/- inMinDelta from the
ideal result.
Site<double> BinarySearch<Tout>(double inFrom, double inTo, double inMinDelta, bool invertingLogic, Func<Site<double>, Site<Tout>> oneMeasurement, Tout outTarget)
Parameters
inFromdoubleThe lower boundary of the search range. Must be less than
inTo.inTodoubleThe upper boundary of the search range. Must be greater than
inFrominMinDeltadoubleThe minimum allowable difference between successive input values, used to determine when the search should stop. Must be >0.
invertingLogicboolA flag indicating whether the output is inverted, meaning increasing output values are a result of decreasing input values.
oneMeasurementFunc<Site<double>, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value for which the corresponding input condition is searched.
Returns
- Site<double>
The input value resulting in an output closest to the target. The worst case delta to the exact input is +/- (
inMinDelta/ 2) if it can be reached given the search range.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(double, double, double, bool, Func<Site<double>, Site<Tout>>, Tout, out Site<Tout>)
Performs a floating point binary search between inFrom and inTo by executing
oneMeasurement at each step. Determines the input resulting in an output closest to the (numeric) target. The number of
steps executed equals log2((inTo - inFrom) / inMinDelta), rounded up to the next
integer. The search ends when the minimum delta is reached, the reported result lies within +/- inMinDelta from the ideal
result. Additionally provides the output value for the input step found.
Site<double> BinarySearch<Tout>(double inFrom, double inTo, double inMinDelta, bool invertingLogic, Func<Site<double>, Site<Tout>> oneMeasurement, Tout outTarget, out Site<Tout> outResult)
Parameters
inFromdoubleThe lower boundary of the search range. Must be less than
inTo.inTodoubleThe upper boundary of the search range. Must be greater than
inFrominMinDeltadoubleThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolA flag indicating whether the output is inverted, meaning increasing output values are a result of decreasing input values.
oneMeasurementFunc<Site<double>, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value for which the corresponding input condition is searched.
outResultSite<Tout>Output - contains the output value for the input found.
Returns
- Site<double>
The input value resulting in an output closest to the target. The worst case delta to the exact input is +/- (
inMinDelta/ 2) if it can be reached given the search range.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(int, int, int, bool, Func<Site<int>, Site<Tout>>, Func<Tout, bool>, int)
Performs an integer binary search between inFrom and inTo by executing oneMeasurement at each step. Determines the input resulting in an output closest to the trip criteria's inflection point. The
number of steps executed does not exceed log2((inTo -inFrom) / inMinDelta),
rounded up to the next integer. The search ends when the input value closest to the transition point (within the specified inMinDelta resolution), but matching the criteria is reached. If no transition was found, the method returns inNotFoundResult.
Site<int> BinarySearch<Tout>(int inFrom, int inTo, int inMinDelta, bool invertingLogic, Func<Site<int>, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, int inNotFoundResult)
Parameters
inFromintThe lower boundary of the search range. Must be less than
inTo.inTointThe upper boundary of the search range. Must be greater than
inFrominMinDeltaintThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolDetermines whether the logic is inverted.
falsemeans higher input values increase the likelihood of meeting the trip criteria.truemeans lower input values do.oneMeasurementFunc<Site<int>, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
inNotFoundResultintThe return value for the case when the trip criteria was never found.
Returns
- Site<int>
The input value resulting in an output fulfilling the trip criteria and be closest to it's inflection point. The worst case deviation from the exact input is (
inMinDelta.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(int, int, int, bool, Func<Site<int>, Site<Tout>>, Func<Tout, bool>, int, out Site<Tout>)
Performs an integer binary search between inFrom and inTo by executing oneMeasurement at each step. Determines the input resulting in an output closest to the trip criteria's inflection point. The
number of steps executed does not exceed log2((inTo -inFrom) / inMinDelta),
rounded up to the next integer. The search ends when the input value closest to the transition point (within the specified inMinDelta resolution), but matching the criteria is reached. If no transition was found, the method returns inNotFoundResult.
Site<int> BinarySearch<Tout>(int inFrom, int inTo, int inMinDelta, bool invertingLogic, Func<Site<int>, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, int inNotFoundResult, out Site<Tout> outResult)
Parameters
inFromintThe lower boundary of the search range. Must be less than
inTo.inTointThe upper boundary of the search range. Must be greater than
inFrominMinDeltaintThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolDetermines whether the logic is inverted.
falsemeans higher input values increase the likelihood of meeting the trip criteria.truemeans lower input values do.oneMeasurementFunc<Site<int>, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
inNotFoundResultintThe return value for the case when the trip criteria was never found.
outResultSite<Tout>Output - contains the output value of the input found.
Returns
- Site<int>
The input value resulting in an output fulfilling the trip criteria and be closest to it's inflection point. The worst case deviation from the exact input is (
inMinDelta.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(int, int, int, bool, Func<Site<int>, Site<Tout>>, Tout)
Performs an integer binary search between inFrom and inTo by executing oneMeasurement at each step. Determines the input resulting in an output closest to the target. The number of steps executed does
not exceed log2((inTo - inFrom) / inMinDelta), rounded up to the next integer. The
search ends when the best input value (within the specified inMinDelta resolution) is reached.
Site<int> BinarySearch<Tout>(int inFrom, int inTo, int inMinDelta, bool invertingLogic, Func<Site<int>, Site<Tout>> oneMeasurement, Tout outTarget)
Parameters
inFromintThe lower boundary of the search range. Must be less than
inTo.inTointThe upper boundary of the search range. Must be greater than
inFrominMinDeltaintThe minimum allowable difference between successive input values, used to determine when the search should stop. Must be >0.
invertingLogicboolA flag indicating whether the output is inverted, meaning increasing output values are a result of decreasing input values.
oneMeasurementFunc<Site<int>, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value for which the corresponding input condition is searched.
Returns
- Site<int>
The input value resulting in an output closest to the target. The worst case delta to the exact input is +/- (
inMinDelta/ 2) if it can be reached given the search range.
Type Parameters
ToutThe type of the device's output.
BinarySearch<Tout>(int, int, int, bool, Func<Site<int>, Site<Tout>>, Tout, out Site<Tout>)
Performs an integer binary search between inFrom and inTo by executing oneMeasurement at each step. Determines the input resulting in an output closest to the target. The number of steps executed does
not exceed log2((inTo - inFrom) / inMinDelta), rounded up to the next integer. The
search ends when the best input value (within the specified inMinDelta resolution) is reached.
Site<int> BinarySearch<Tout>(int inFrom, int inTo, int inMinDelta, bool invertingLogic, Func<Site<int>, Site<Tout>> oneMeasurement, Tout outTarget, out Site<Tout> outResult)
Parameters
inFromintThe lower boundary of the search range. Must be less than
inTo.inTointThe upper boundary of the search range. Must be greater than
inFrominMinDeltaintThe minimum allowable difference between successive input values, used to determine when the search should stop.
invertingLogicboolA flag indicating whether the output is inverted, meaning increasing output values are a result of decreasing input values.
oneMeasurementFunc<Site<int>, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value for which the corresponding input condition is searched.
outResultSite<Tout>Output - contains the output value for the input found.
Returns
- Site<int>
The input value resulting in an output closest to the target. The worst case delta to the exact input is +/- (
inMinDelta/ 2) if it can be reached given the search range.
Type Parameters
ToutThe type of the device's output.
LinearFullFromIncCount<Tin>(Tin, Tin, int, Action<Tin>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. The ramp ends after inCount measurements are completed.
void LinearFullFromIncCount<Tin>(Tin inFrom, Tin inIncrement, int inCount, Action<Tin> oneMeasurement)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
oneMeasurementAction<Tin>The action to execute for every measurement.
Type Parameters
TinThe type of the input condition for the device.
LinearFullFromToCount<Tin>(Tin, Tin, int, Action<Tin>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. The ramp ends after inCount measurements are
completed.
Tin LinearFullFromToCount<Tin>(Tin inFrom, Tin inTo, int inCount, Action<Tin> oneMeasurement)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
oneMeasurementAction<Tin>The action to execute for every measurement.
Returns
- Tin
The calculated increment, for later use in the processing step (ignore if not needed).
Type Parameters
TinThe type of the input condition for the device.
LinearFullFromToInc<Tin>(Tin, Tin, Tin, Action<Tin>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. The ramp ends with the last input less or equal inTo.
void LinearFullFromToInc<Tin>(Tin inFrom, Tin inTo, Tin inIncrement, Action<Tin> oneMeasurement)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
oneMeasurementAction<Tin>The action to execute for every measurement.
Type Parameters
TinThe type of the input condition for the device.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or after inCount measurements are completed.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or after inCount measurements are completed.
Additionally provides the index of the input step found.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>, out Site<Tout>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or after inCount measurements are completed.
Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex, out Site<Tout> tripOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
tripOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed. Additionally provides the index of the input step found.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromIncCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>, out Site<Tout>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed. Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromIncCount<Tin, Tout>(Tin inFrom, Tin inIncrement, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex, out Site<Tout> closestOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inCountintThe total number of steps to execute.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
closestOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the first input meeting the
outTripCriteria. The ramp stops prematurely when the trip criteria is met on all sites, or after
inCount measurements are completed.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the first input meeting the
outTripCriteria. The ramp stops prematurely when the trip criteria is met on all sites, or after
inCount measurements are completed. Additionally provides the index of the input step found.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>, out Site<Tout>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the first input meeting the
outTripCriteria. The ramp stops prematurely when the trip criteria is met on all sites, or after
inCount measurements are completed. Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex, out Site<Tout> tripOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
tripOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the input resulting in an output closest to the
(numeric) outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the input resulting in an output closest to the
(numeric) outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed. Additionally provides the index of the input step found.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToCount<Tin, Tout>(Tin, Tin, int, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>, out Site<Tout>)
Performs a linear search between inFrom and inTo with inCount inputs. Executes
oneMeasurement at each step including the end points. Determines the input resulting in an output closest to the
(numeric) outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or after inCount measurements are completed. Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromToCount<Tin, Tout>(Tin inFrom, Tin inTo, int inCount, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex, out Site<Tout> closestOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inCountintThe number of equally spaced steps to execute, including both endpoints exactly.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
closestOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or with the last input less or equal inTo.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or with the last input less or equal inTo.
Additionally provides the index of the input step found.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Func<Tout, bool>, out Site<int>, out Site<Tout>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the first input meeting the outTripCriteria.
The ramp stops prematurely when the trip criteria is met on all sites, or with the last input less or equal inTo.
Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Func<Tout, bool> outTripCriteria, out Site<int> tripIndex, out Site<Tout> tripOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTripCriteriaFunc<Tout, bool>A delegate indicating the output meets the condition required for the input value searched.
tripIndexSite<int>Output - contains the index of the input step found.
tripOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The first input value resulting in an output satisfying the trip criteria.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Tout)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or with the last input less or
equal inTo.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or with the last input less or
equal inTo. Additionally provides the index of the input step found.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.
LinearStopFromToInc<Tin, Tout>(Tin, Tin, Tin, Tin, Tin, Func<Tin, Site<Tout>>, Tout, out Site<int>, out Site<Tout>)
Performs a linear search from inFrom by increasing with inIncrement. Executes oneMeasurement at each step including the start point. Determines the input resulting in an output closest to the (numeric)
outTarget. The ramp stops prematurely when the target output is surpassed on all sites, or with the last input less or
equal inTo. Additionally provides the index and output value of the input step found.
Site<Tin> LinearStopFromToInc<Tin, Tout>(Tin inFrom, Tin inTo, Tin inIncrement, Tin inOffset, Tin inNotFoundResult, Func<Tin, Site<Tout>> oneMeasurement, Tout outTarget, out Site<int> closestIndex, out Site<Tout> closestOut)
Parameters
inFromTinThe starting point of the linear input ramp.
inToTinThe end point of the linear input ramp.
inIncrementTinThe input increment value for every step.
inOffsetTinThe offset to correct the calculated input value. Use negative values to compensate propagation delays for output switching.
inNotFoundResultTinThe return value for the case when the trip criteria was never found.
oneMeasurementFunc<Tin, Site<Tout>>The action to execute for every measurement.
outTargetToutThe (numeric) target output value to be searched.
closestIndexSite<int>Output - contains the index of the input step found.
closestOutSite<Tout>Output - contains the output value of the input step found.
Returns
- Site<Tin>
The input value resulting in an output closest to the target.
Type Parameters
TinThe type of the input condition for the device.
ToutThe type of the device's output.