File: CxxFlags.Rd

package info (click to toggle)
r-cran-stanheaders 2.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 19,652 kB
  • sloc: cpp: 125,776; ansic: 73,706; f90: 30,959; ml: 243; sh: 15; makefile: 5
file content (32 lines) | stat: -rw-r--r-- 1,056 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
\name{CxxFlags}
\alias{CxxFlags}
\alias{LdFlags}
\title{Compilation flags for StanHeaders
}
\description{
Output the compiler or linker flags required to build with the \pkg{StanHeaders}
package
}
\usage{
  CxxFlags(as_character = FALSE)
  LdFlags(as_character = FALSE)
}

\arguments{
  \item{as_character}{
    A logical scalar that defaults to \code{\link{FALSE}} that indicates whether
    to return the compiler or linker flags as a \code{\link{character}} vector of
    length one. Otherwise, the compiler or linker flags are merely output to the
    screen, which is appropriate when called from a Makevars or Makevars.win file
  }
}
\details{
  These functions are currently not exported and are typically called from a Makevars 
  or a Makevars.win file of another package.
}
\value{
  If \code{as_character} is \code{\link{TRUE}}, then these functions return
  a character vector of length one. Otherwise, (which is the default) these
  functions return \code{\link{NULL}} invisibly after outputing the compiler
  or linker flags to the screen.
}