R/autodiff.R

In Non-Contradiction/autodiffr: Automatic Differentiation in R through 'Julia'

#' Do initial setup for package autodiffr.
#'
#' \code{ad_setup} does the initial setup for package autodiffr.
#'
#' @param reverse whether to use load reverse mode automatic differentiation.
#' @param forward whether to use forward mode automatic differentiation.
#' @param JULIA_HOME the file folder which contains julia binary,
#'     if not set, it will try to look at global option JULIA_HOME,
#'     if the global option is not set,
#'     it will then look at the environmental variable JULIA_HOME,
#'     if still not found, julia in path will be used.
#' @param verbose whether to print package startup messages.
#' @param ... arguments passed to \code{JuliaCall::julia_setup}.
#'
#' @examples
#' \dontrun{
#' ad_setup()
#' }
#'
#' @export
ad_setup <- function(JULIA_HOME = NULL, reverse = TRUE, forward = TRUE, verbose = TRUE, ...) {
    if (!isTRUE(.AD$inited)) {
        JuliaCall::julia_setup(JULIA_HOME = JULIA_HOME, verbose = verbose, ...)

        JuliaCall::julia_source(system.file("/julia/autodiffr.jl", package = "autodiffr"))
        # .AD$julia$install_package_if_needed("DiffResults")
        # .AD$julia$library("DiffResults")

        if (reverse) {
            if (verbose) message("Loading ReverseDiff...")

            JuliaCall::julia_source(system.file("/julia/reverse.jl", package = "autodiffr"))

            # .AD$julia$install_package_if_needed("ReverseDiff")
            # .AD$julia$library("ReverseDiff")
            #
            # ## Need to define is_tape function for ReverseDiff
            # JuliaCall::julia_command("function is_tape(x) typeof(x) <: ReverseDiff.AbstractTape end;")
            #
            # JuliaCall::julia_command("import Base.float")
            # JuliaCall::julia_command("using Suppressor")
            # JuliaCall::julia_command("@suppress begin function Base.float(t::ReverseDiff.TrackedReal{V,D,O}) where {V,D,O} t end end")
            #
            # JuliaCall::julia_command("(::Type{ReverseDiff.TrackedReal{V,D,O}})(t::ReverseDiff.TrackedReal{V,D,O}) where {V,D,O} = t")
        }

        if (forward) {
            if (verbose) message("Loading ForwardDiff...")

            JuliaCall::julia_source(system.file("/julia/forward.jl", package = "autodiffr"))

            # .AD$julia$install_package_if_needed("ForwardDiff")
            # .AD$julia$library("ForwardDiff")
            #
            # JuliaCall::julia_command("import Base.promote_rule")
            # JuliaCall::julia_command("Base.promote_rule(::Type{Bool}, ::Type{ForwardDiff.Dual{T,V,N}}) where {T,V<:Real,N} = ForwardDiff.Dual{T,promote_type(Bool, V),N}")
            # JuliaCall::julia_command("Base.promote_rule(::Type{ForwardDiff.Dual{T,V,N}}, ::Type{Bool}) where {T,V<:Real,N} = ForwardDiff.Dual{T,promote_type(V, Bool),N}")
        }

        apiFuncs(reverse = reverse, forward = forward)

        .AD$julia07 <- JuliaCall::julia_eval('VERSION > v"0.6.5"')

        .AD$inited <- TRUE

        if (verbose) message("Finish autodiffr setup.")
    }
}