Skip to content

Main content

Household Equivalence Unit Flag Tool

Apply caller-supplied household category equivalence factors without selecting an official equivalence scale.

Loading tool…

Description

Sum counts×weights when enabled or raw counts otherwise, returning raw total separately.

Food access records may describe travel time, eligibility, household equivalents or service coverage. Each summary depends on its supplied denominator and classification; it is not a complete measure of household food security.

Sum counts×weights when enabled or raw counts otherwise, returning raw total separately.

When to use this tool

Use Household Equivalence Unit Flag when you need a transparent access, eligibility or coverage calculation.

How to use the tool and how it works

  1. Enter memberCounts, suppliedWeights, useWeights. Keep parallel arrays aligned. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read equivalentUnits, rawMembers. Use the output convention below.

Require aligned nonnegative member counts and weights. Sum counts×weights when enabled or raw counts otherwise, returning raw total separately.1

Input fieldMeaning and unitsAccepted input
memberCountsNonnegative integer household-member counts.Required. Array of safe integer; maximum items 256.
suppliedWeightsNonnegative caller-defined equivalence weights, possibly fractional.Required. Array of finite number; maximum items 256.
useWeightsUse WeightsRequired. Boolean.
Output fieldInterpretationReturned shape
equivalentUnitsEquivalent UnitsRequired. Finite number.
rawMembersRaw MembersRequired. Safe integer.
json
{
  "input": {
    "memberCounts": [
      2,
      3
    ],
    "suppliedWeights": [
      1,
      0.5
    ],
    "useWeights": true
  },
  "output": {
    "equivalentUnits": 3.5,
    "rawMembers": 5
  }
}

Limitations and assumptions

  • Weights are supplied equivalents, not an official household or nutritional scale. Member counts are nonnegative integers; weights may be fractional.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
  • Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.

Alternative or Complementary methods

Review the actual household context, service rules and source records. Combine appropriate field assessment with quantitative summaries when access, equity or nutritional needs matter.

References

  1. Calculation and input contract: food-security/household-equivalence-unit-flag — tool.io

Similar or alternative tools