biogeme.models.nested module¶
Simplified nested logit model using the dedicated LogNested expression.
- biogeme.models.nested.getMevForNested(V, availability, nests)[source]¶
Warning
This function is deprecated. Use
get_mev_for_nested()instead.Deprecated name for get_mev_for_nested.
- Return type:
dict[int,Expression]- Parameters:
V (dict[int, Expression])
availability (dict[int, Expression] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
- biogeme.models.nested.getMevForNestedMu(util, availability, nests, mu)[source]¶
Warning
This function is deprecated. Use
get_mev_for_nested_mu()instead.Deprecated name for get_mev_for_nested_mu.
- Return type:
dict[int,Expression]- Parameters:
util (dict[int, Expression])
availability (dict[int, Expression] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
mu (Expression)
- biogeme.models.nested.getMevGeneratingForNested(util, availability, nests)[source]¶
Warning
This function is deprecated. Use
get_mev_generating_for_nested()instead.Deprecated name for get_mev_generating_for_nested.
- Return type:
- Parameters:
util (dict[int, Expression])
availability (dict[int, Expression])
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
- biogeme.models.nested.get_mev_for_nested(util, availability, nests)[source]¶
Implements the derivatives of the MEV generating function.
Kept for backward compatibility.
- Return type:
dict[int,Expression]- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
- biogeme.models.nested.get_mev_for_nested_mu(util, availability, nests, mu)[source]¶
Implements the MEV derivative terms for explicit-mu nested logit.
Kept for backward compatibility.
- Return type:
dict[int,Expression]- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
mu (Expression | float | int | bool)
- biogeme.models.nested.get_mev_generating_for_nested(util, availability, nests)[source]¶
Implements the MEV generating function for the nested logit model.
Kept for backward compatibility.
- Return type:
- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
- biogeme.models.nested.lognested(util, availability, nests, choice)[source]¶
Log probability for the nested logit model.
- Return type:
- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression | float | int | bool)
- biogeme.models.nested.lognestedMevMu(util, availability, nests, choice, mu)[source]¶
Warning
This function is deprecated. Use
lognested_mev_mu()instead.Deprecated name for lognested_mev_mu.
- Return type:
- Parameters:
util (dict[int, Expression])
availability (dict[int, Expression] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression)
mu (Expression)
- biogeme.models.nested.lognested_mev_mu(util, availability, nests, choice, mu)[source]¶
Log probability for the nested logit model with explicit mu.
- Return type:
- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression | float | int | bool)
mu (Expression | float | int | bool)
- biogeme.models.nested.nested(util, availability, nests, choice)[source]¶
Choice probability for the nested logit model.
- Return type:
- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression | float | int | bool)
- biogeme.models.nested.nestedMevMu(util, availability, nests, choice, mu)[source]¶
Warning
This function is deprecated. Use
nested_mev_mu()instead.Deprecated name for nested_mev_mu.
- Return type:
- Parameters:
util (dict[int, Expression])
availability (dict[int, Expression] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression)
mu (Expression)
- biogeme.models.nested.nested_mev_mu(util, availability, nests, choice, mu)[source]¶
Choice probability for the nested logit model with explicit mu.
- Return type:
- Parameters:
util (dict[int, Expression | float | int | bool])
availability (dict[int, Expression | float | int | bool] | None)
nests (NestsForNestedLogit | tuple[tuple[Expression | float | int | bool, list[int]], ...])
choice (Expression | float | int | bool)
mu (Expression | float | int | bool)