R/add.diag.R

In MoBPS: Modular Breeding Program Simulator

'#
  Authors
Torsten Pook, torsten.pook@uni-goettingen.de

Copyright (C) 2017 -- 2020  Torsten Pook

This program 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.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
'#

#' Add something to the diagonal
#'
#' Function to add numeric to the diagonal of a matrix
#' @param M Matrix
#' @param d Vector to add to the diagonal of the matrix
#' @return Matrix with increased diagonal elements
#' @examples
#' A <- matrix(c(1,2,3,4), ncol=2)
#' B <- add.diag(A, 5)
#' @return Matrix with modified diagonal entries
#' @export

add.diag <- function(M, d){
  diag(M) <- diag(M) + d
  return(M)
}