MultiArray

Neo-Bahamut · May 23, 2009

MultiArray Version: 2.2
By: Neo-Bahamut

Introduction

I think most of you scripters know what a Table and an Array is, right?
Both have advantages and disadantages. Tables can only hold Integers and Arrays have only one dimension.
This script creates the MultiArray class which is like an Array but can have any number of dimensions.

Methods:

MultiArray.new(D1, D2, D3, D4...) (creates a new MultiArray)
[1, 2, 3, 4] (returns the value at that position)
[1, 2, 3, 4] = object (sets the value at that position to object)
.fill(object[, duplicate = true]) fills each position with object. If duplicate is true, the .dup method of object is called evertime
all methods of Enumerable

Script

Code:

#============================================================================

# ** MultiArray

#----------------------------------------------------------------------------

# Neo-Bahamut

# V 2.4

# 23.06.2009

#============================================================================

 

 

#=============================================================================

# ** MultiArray

#-----------------------------------------------------------------------------

#  Some kind of Table-Array-Fusion.

#=============================================================================

class MultiArray

  

  include Enumerable

  

  SizeError      = Exception.new("Too large amount of data.")

  CopyError      = Exception.new("Object can not be duplicated.")

  RangeError     = Exception.new("Index out of Range.")

  

  #--------------------------------------------------------------------------

  # * Initialization

  #--------------------------------------------------------------------------

  def initialize(*args)

    @sizes = args

    size = 1

    args.each {|n| size *= n}

    if size.is_a?(Bignum)

      raise SizeError

    end

    @array = Array.new(size)

  end

  

  #--------------------------------------------------------------------------

  # * Gets an element.

  #--------------------------------------------------------------------------

  def [](*args)

    raise RangeError if args.size > @sizes.size

    args.each_index {|n| if args[n] >= @sizes[n] then raise RangeError end}

    index = 0

    for n in 0...args.size

      i = args[n]

      for m in [email=0...@sizes.size]0...@sizes.size[/email]

        break if m >= n

        i *= @sizes[m]

      end

      index += i

    end

    return @array[index]

  end

  

  #--------------------------------------------------------------------------

  # * Changes an element.

  #--------------------------------------------------------------------------

  def []=(*args)

    object = args.pop

    raise RangeError if args.size > @sizes.size

    args.each_index {|n| if args[n] >= @sizes[n] then raise RangeError end}

    index = 0

    for n in 0...args.size

      i = args[n]

      for m in [email=0...@sizes.size]0...@sizes.size[/email]

        break if m >= n

        i *= @sizes[m]

      end

      index += i

    end

    @array[index] = object

  end

  

  #--------------------------------------------------------------------------

  # * Method description

  #     obj: The Object the Array will be filled with.

  #     dup: If true, obj is duplicated for each tile

  #--------------------------------------------------------------------------

  def fill(obj, dup = true)

    begin

      for n in [email=0...@array.size]0...@array.size[/email]

        i = dup ? obj.dup : obj

        @array[n] = i

      end

    rescue

      raise CopyError

    end

  end

  

  #--------------------------------------------------------------------------

  # * Iterates for each element.

  #--------------------------------------------------------------------------

  def each(&block)

    @array.each(&block)

  end

  

end

Instructions

Code:

marray = MultiArray.new(1, 2, 3)

marray[1, 2, 2] = 1

p marray[1, 2, 2] # => 1

MultiArrays have a fixed size as Tables. They also can't be too big (too big means each size multiplicated is a Bignum)

FAQ

Nothing asked

Compatibility

Should be compatibel with anything that doesn't make a MultiArray-class

Terms and Conditions

I think this will be only used for writing scripts and not just be put into a game ;D
So if you use this as a help for your script, please write me with you in the Credits (or at least to "Thanks")
If somebody uses a script which uses this one, please add me too to your credits.

nowayskill · May 24, 2009

Neo-Bahamut":3b1kpqq8 said:

MultiArray Version: 2.2
By: Neo-Bahamut

Introduction

I think most of you scripters know what a Table and an Array is, right?
Both have advantages and disadantages. Tables can only hold Integers and Arrays have only one dimension.
This script creates the MultiArray class which is like an Array but can have any number of dimensions.

Methods:

MultiArray.new(D1, D2, D3, D4...) (creates a new MultiArray)
[1, 2, 3, 4] (returns the value at that position)
[1, 2, 3, 4] = object (sets the value at that position to object)
.fill(object[, duplicate = true]) fills each position with object. If duplicate is true, the .dup method of object is called evertime
all methods of Enumerable

Script

Code:

#============================================================================

# ** MultiArray

#----------------------------------------------------------------------------

# Neo-Bahamut

# V 2.2

# 23.05.2009

#============================================================================

Â 

Â 

#=============================================================================

# ** MultiArray

#-----------------------------------------------------------------------------

# Â Some kind of Table-Array-Fusion.

#=============================================================================

class MultiArray

Â  

Â  include Enumerable

Â  

Â  SizeError Â  Â  Â = Exception.new("Too large amount of data.")

Â  CopyError Â  Â  Â = Exception.new("Object can not be duplicated.")

Â  RangeError Â  Â  = Exception.new("Index out of Range.")

Â  

Â  #--------------------------------------------------------------------------

Â  # * Initialization

Â  #--------------------------------------------------------------------------

Â  def initialize(*args)

Â  Â  @sizes = args

Â  Â  size = 1

Â  Â  args.each {|n| size *= n}

Â  Â  if size.is_a?(Bignum)

Â  Â  Â  raise SizeError

Â  Â  end

Â  Â  @array = Array.new(size)

Â  end

Â  

Â  #--------------------------------------------------------------------------

Â  # * Gets an element.

Â  #--------------------------------------------------------------------------

Â  def [](*args)

Â  Â  args.each_index {|n| if args[n] >= @sizes[n] then raise RangeError end}

Â  Â  index = 0

Â  Â  for n in 0...args.size

Â  Â  Â  i = args[n]

Â  Â  Â  for m in [email=0...@sizes.size]0...@sizes.size[/email]

Â  Â  Â  Â  break if m >= n

Â  Â  Â  Â  i *= m

Â  Â  Â  end

Â  Â  Â  index += i

Â  Â  end

Â  Â  return @array[index]

Â  end

Â  

Â  #--------------------------------------------------------------------------

Â  # * Changes an element.

Â  #--------------------------------------------------------------------------

Â  def []=(*args)

Â  Â  object = args.pop

Â  Â  args.each_index {|n| if args[n] >= @sizes[n] then raise RangeError end}

Â  Â  index = 0

Â  Â  for n in 0...args.size

Â  Â  Â  i = args[n]

Â  Â  Â  for m in [email=0...@sizes.size]0...@sizes.size[/email]

Â  Â  Â  Â  break if m >= n

Â  Â  Â  Â  i *= @sizes[m]

Â  Â  Â  end

Â  Â  Â  index += i

Â  Â  end

Â  Â  @array[index] = object

Â  end

Â  

Â  #--------------------------------------------------------------------------

Â  # * Method description

Â  # Â  Â  obj: The Object the Array will be filled with.

Â  # Â  Â  dup: If true, obj is duplicated for each tile

Â  #--------------------------------------------------------------------------

Â  def fill(obj, dup = true)

Â  Â  begin

Â  Â  Â  for n in [email=0...@array.size]0...@array.size[/email]

Â  Â  Â  Â  i = dup ? obj.dup : obj

Â  Â  Â  Â  @array[n] = i

Â  Â  Â  end

Â  Â  rescue

Â  Â  Â  raise CopyError

Â  Â  end

Â  end

Â  

Â  #--------------------------------------------------------------------------

Â  # * Iterates for each element.

Â  #--------------------------------------------------------------------------

Â  def each(&block)

Â  Â  @array.each(&block)

Â  end

Â  

end

Instructions

FAQ

Nothing asked

Compatibility

Should be compatibel with anything that doesn't make a MultiArray-class

Terms and Conditions

I think this will be only used for writing scripts and not just be put into a game ;D
So if you use this as a help for your script, please write me with you in the Credits (or at least to "Thanks")
If somebody uses a script which uses this one, please add me too to your credits.

Ruby support multi-dimensional arrays..

array2d = [][]
array2d[1][2] = 3
print array2d[1][2]
Output: 3

hanmac · May 24, 2009

yes but this is for:

array[0,4,5] = 3

its better to handle

rey meustrus · May 28, 2009

Not really. The same syntax,

Zeriab · May 28, 2009

If you want to put restrictions then encapsulating the multiarray in a class can be a good idea.
A perfect example of this is the Matrix class which is available for requiring in the standard ruby distribution. It's not available in XP/VX. The matrix is basically a 2-dimensional array with certain restrictions and loads of auxiliary methods.

The array[0,4,5] = 3 has the advantage of one being able to do array[*args] = 3.
Basically if you have a code which can deal with an arbitrary number of dimensions there can be an advantage.

I get an illegal argument error when trying to run the code nowayskill shows:
[ruby]array2d = [][]
[/ruby]
It may work in another version, but not in version 1.8.1, i.e. the version of Ruby used in RMXP. (I believe also VX uses 1.8.1)
I doubt it since [] creates an array and [][] complains about lack of arguments for the look-up method call. I.e. [][0] #=> nil. [][] #=> Argument error
So it appears that Ruby does not have support for multi-dimensional arrays in terms of syntactic sugar.

@Neo-Bahamut:
The script at hand can be described as a function which maps a number of arguments for an n-dimensional table onto a single array. The size must be known when creating the array.
You should make a note telling that the array can only hold up to a Fixnum number of elements since its a restriction you enforce.
You definitely tell that the dimensions are fixed. I.e. you cannot change the size of a MultiArray after having created it. You have some nice error catching after all ^_^
I would suggest also checking for if args.size == @sizes.size

*hugs*

Neo-Bahamut · May 29, 2009

@nowayskill & rey meustrus: As Zeriab said, RGSS/Ruby 1.8.1 does not have this method.

The script at hand can be described as a function which maps a number of arguments for an n-dimensional table onto a single array. The size must be known when creating the array.
You should make a note telling that the array can only hold up to a Fixnum number of elements since its a restriction you enforce.
You definitely tell that the dimensions are fixed.

Sorry, I don't really understand you. Do you mean I should add a How-to-use in the beginning?
(my english is bad recently ^^")

I wanted to add the feature that you can change the sizes but then I noticed that I'd have to define @array new every time and calculate the new positions. And I was to lazy to think about an algorithm which workd :D

I would suggest also checking for if args.size == @sizes.size

Added. Well... I hope you meant this ^^"

Zeriab · May 29, 2009

No I didn't mean that you should add a How-to-use.
I am suggestion that you add something like:
Like a Table the size of a MultiArray is fixed.

You understood my args.size == @sizes.size suggestion correction ^_^

Neo-Bahamut · May 29, 2009

Like this?

(see Instructions)

Zeriab · May 30, 2009

Yup. Exactly like that :3

Ulqiorra · May 31, 2009

Actually, for a 2d array, just do:

array = [[],[]]
array[0][0] = 2
p array[0][0]

But yes, this is pretty cool. It's probably better than what i just said.

Zeriab · May 31, 2009

That approach have it's problems:
[ruby]a = [[],[]]
p a[3][2]
[/ruby]

Neo-Bahamut · May 31, 2009

@ Near: And your method requires more memory.
I tested one Array (500*500*500) and an Array with 500 Arrays in it and each of that Arrays had a Array (500) in it too.
The single big one requires about 95 MB and the large number of Arrays 123 MB

gerrtunk · Jun 21, 2009

marray = MultiArray.new(1, 2, 3)
marray[1, 2, 2] = 1
p marray[1, 2, 2] # => 1

I just copy the script and test this and get me an Range Exception error in line 60.
Library=RGSS102J.dll

Neo-Bahamut · Jun 21, 2009

The indexes start with 0 not with 1.
So the first and second dimensions you want to set do not exist.

gerrtunk · Jun 21, 2009

Mmmm
I changued it to:

marray = MultiArray.new(4, 5, 6)
marray[1, 2, 2] = 1
print marray[1, 2, 2] # => 1

But i have a new problem, print tells me that 1,2,2 is nill. I'm missing something?

Neo-Bahamut · Jun 23, 2009

Oh, yeah...
There was a bug in the script ^^"
I will update the first post (also because the script seems to be destroyed through the forum change)

Envision, Create, Share

MultiArray

Neo-Bahamut

nowayskill

hanmac

rey meustrus

Zeriab

Neo-Bahamut

Zeriab

Neo-Bahamut

Zeriab

Ulqiorra

Zeriab

Neo-Bahamut

gerrtunk

Neo-Bahamut

gerrtunk

Neo-Bahamut

Share this page

Thank you for viewing

Discord

RPG Maker

Content