solve_notarget.mnl: Solver for multinomial logit type problems, using only prior...

View source: R/solve_notarget.R

solve_notarget.mnlR Documentation

Solver for multinomial logit type problems, using only prior module projections

Description

Solver for multinomial logit type problems, using only prior module projections

Usage

solve_notarget.mnl(
  targets,
  areas,
  xmat,
  betas,
  restrictions = NULL,
  options = downscale_control()
)

Arguments

targets

A dataframe with columns lu.from, lu.to and value (all targets will be ignored)

areas

A dataframe of areas with columns lu.from, ns and value, with all areas >= 0 and with sum(areas) >= sum(targets)

xmat

A dataframe of explanatory variables with columns ks and value.

betas

A dataframe of coefficients with columns ks, lu.from, lu.to & value

restrictions

A dataframe with columns ns, lu.from, lu.to and value. Values must be zero or one. If restrictions are one, the MNL function is set to zero

options

A list with solver options. Call downscale_control for default options and for more detail.

Details

Given p targets matches the projections from an MNL-type model.

You should not call this functions directly, call downscale instead.

Areas correspond to either an areas per pixel (ns), with value or optionally the are of lu.from in a pixel. All areas must be larger The function expects lu.from

Value

A list containing

  • out.res A n x p matrix of area allocations

  • out.solver NULL, returned for compatibility

Examples

## A basic example

tkrisztin/downscalr documentation built on June 2, 2025, 1:16 a.m.