R/makeMultiIndex.R

In fields: Tools for Spatial Data

#
# fields  is a package for analysis of spatial data written for
# the R software environment.
# Copyright (C) 2024 Colorado School of Mines
# 1500 Illinois St., Golden, CO 80401
# Contact: Douglas Nychka,  douglasnychka@gmail.com,
#
# 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 2 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 the R software environment if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# or see http://www.r-project.org/Licenses/GPL-2
##END HEADER
makeMultiIndex<- function(M){
# M are  L integers with product prodM
# Will create a  prodM by L matrix that is all combinations of (1:M[i]) for i =1,2, ...L
# This is organized in the standard array ordering where the first column varies the fastest
#  for M = c( 3,2,4)
# 24 rows     bigIndex =  1,1,1 
#                          2,1,1
#                          3,1,1
#                          1,2,1
#                          2,2,1
#                          3,2,1
#                      etc
#                ending at
#                          2,2,4
#                          3,2,4
                
  L<- length( M)
# qucik return for L =1 and 2  
  if( L ==1){ 
    bigIndex<- cbind(1:M[1] )
  }
  if( L==2){
    bigIndex<-  cbind( rep(1:M[1], M[2]),  
                      rep( 1:M[2], rep(M[1], M[2]) )
    )
  }
  if( L > 2){
    prodM<- prod( M)
    bigIndex<-matrix( NA, prodM,L)
    
    for ( k in 1: L){
      if( k ==1){
        ML<- 1
      }
      else{
        ML<- prod( M[1: (k-1)] )
      }
      
      if( k ==L){
        MU<- 1}
      else{
        MU<-prod( M[ (k+1) :  L  ] )
      }
      gridTmp<- rep( 1:M[k],  rep(ML, M[k]) )
      bigIndex[,k]<- rep( gridTmp, MU)
    }
  }
return( bigIndex )  
  
}