subHeadings: Subtract 'headings'

In NetLogoR: Build and Run Spatially Explicit Agent-Based Models

Subtract headings

Description

Compute the difference between headings.

Usage

subHeadings(angle1, angle2, range360 = FALSE)

## S4 method for signature 'numeric,numeric'
subHeadings(angle1, angle2, range360 = FALSE)

## S4 method for signature 'agentMatrix,numeric'
subHeadings(angle1, angle2, range360 = FALSE)

## S4 method for signature 'numeric,agentMatrix'
subHeadings(angle1, angle2, range360 = FALSE)

## S4 method for signature 'agentMatrix,agentMatrix'
subHeadings(angle1, angle2, range360 = FALSE)

Arguments

angle1	AgentMatrix object representing the moving agents, or Numeric. Vector of angles.
angle2	AgentMatrix object representing the moving agents, or Numeric. Vector of angles.
range360	Logical. If range360 = TRUE, returned values are between 0 and 360 degrees; if range360 = FALSE, returned values are between -180 and 180 degrees. Default is range360 = FALSE.

Details

This function does the opposite as the one in NetLogo where angle1 is the target heading.

    `angle1` and `angle2` must be of the same length or if different,
    one of them must be of length 1.

     Positive values mean clockwise rotations, negative value mean
     counterclockwise rotations.

Value

Numeric. Vector of the smallest angles in degrees by which angle1 could be rotated to produce angle2 (i.e., the target heading).

Author(s)

Sarah Bauduin

References

Wilensky, U. 1999. NetLogo. http://ccl.northwestern.edu/netlogo/. Center for Connected Learning and Computer-Based Modeling, Northwestern University. Evanston, IL.

See Also

https://ccl.northwestern.edu/netlogo/docs/dictionary.html#subtract-headings

Examples

w1 <- createWorld(minPxcor = 0, maxPxcor = 9, minPycor = 0, maxPycor = 9)
t1 <- createOTurtles(n = 10, world = w1)
subHeadings(angle1 = t1, angle2 = 0)

NetLogoR documentation built on Aug. 17, 2022, 9:06 a.m.