R/mean_of_gumbel_function.R

In niknap/ScalingFunctions: Collection of functions for scaling of distributions

# Copyright (C) 2019 Dr. Nikolai Knapp, UFZ
#
# This file is part of the ScalingFunctions R package.
#
# The ScalingFunctions R package is free software: you can redistribute
# it and/or modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ScalingFunctions is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ScalingFunctions. If not, see <http://www.gnu.org/licenses/>.



#' Mean of gumbel distribution
#'
#' Calculation of the arithmetic mean of a gumbel
#' distribution from function parameters
#' @param loc Location parameter of the gumbel distribution
#' @param scale Scale parameter of the gumbel distribution
#' @return Arithmetic mean of gumbel distribution
#' @author Nikolai Knapp, nikolai.knapp@ufz.de

mean_of_gumbel <- function(loc, scale){
  # Negative digamma(1) is the Euler-Mascheroni constant
  mean <- loc+scale*(-digamma(1))
  names(mean) <- "mean"
  return(mean)
}