trend_c {GauPro}R Documentation

Trend R6 class

Description

Trend R6 class

Trend R6 class

Format

R6Class object.

Value

Object of R6Class with methods for fitting GP model.

Super class

GauPro::GauPro_trend -> GauPro_trend_c

Public fields

m

Trend parameters

m_lower

m lower bound

m_upper

m upper bound

m_est

Should m be estimated?

Methods

Public methods


Method new()

Initialize trend object

Usage
trend_c$new(m = 0, m_lower = -Inf, m_upper = Inf, m_est = TRUE, D = NA)
Arguments
m

trend initial parameters

m_lower

trend lower bounds

m_upper

trend upper bounds

m_est

Logical of whether each param should be estimated

D

Number of input dimensions of data


Method Z()

Get trend value for given matrix X

Usage
trend_c$Z(X, m = self$m, params = NULL)
Arguments
X

matrix of points

m

trend parameters

params

trend parameters


Method dZ_dparams()

Derivative of trend with respect to trend parameters

Usage
trend_c$dZ_dparams(X, m = self$m, params = NULL)
Arguments
X

matrix of points

m

trend values

params

overrides m


Method dZ_dx()

Derivative of trend with respect to X

Usage
trend_c$dZ_dx(X, m = self$m, params = NULL)
Arguments
X

matrix of points

m

trend values

params

overrides m


Method param_optim_start()

Get parameter initial point for optimization

Usage
trend_c$param_optim_start(jitter = F, m_est = self$m_est)
Arguments
jitter

Not used

m_est

If the trend should be estimate.


Method param_optim_start0()

Get parameter initial point for optimization

Usage
trend_c$param_optim_start0(jitter = F, m_est = self$m_est)
Arguments
jitter

Not used

m_est

If the trend should be estimate.


Method param_optim_lower()

Get parameter lower bounds for optimization

Usage
trend_c$param_optim_lower(m_est = self$m_est)
Arguments
m_est

If the trend should be estimate.


Method param_optim_upper()

Get parameter upper bounds for optimization

Usage
trend_c$param_optim_upper(m_est = self$m_est)
Arguments
m_est

If the trend should be estimate.


Method set_params_from_optim()

Set parameters after optimization

Usage
trend_c$set_params_from_optim(optim_out)
Arguments
optim_out

Output from optim


Method clone()

The objects of this class are cloneable with this method.

Usage
trend_c$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

t1 <- trend_c$new()

[Package GauPro version 0.2.12 Index]