使用 FFI 和 C 函数在 ruby 中创建动态数组 class
creating a Dynamic array class in ruby using FFI and C function
我想在 ruby 中创建自己的动态数组 class(作为训练)。
这个想法是让 class DynamicArray 具有容量(它在给定时刻可以容纳的元素数量)、大小(在给定时刻实际推入数组的元素数量)和a static_array 这是一个固定大小的静态整数数组。每当此 static_array 已满时,我们将创建一个容量为原始 static_array 两倍的新静态数组,并复制新 static_array 中的每个元素。
由于 ruby 中没有静态数组,我的想法是使用 FFI https://github.com/ffi/ffi。在 c 中创建一个函数,该函数创建一个大小为 n 的静态 int 数组,然后能够在我的 ruby 程序中使用它。
我对 C 知之甚少,很难理解 FFI 的文档
这是我目前所拥有的,一个 create_array.c 文件,它定义了我的 c 函数来创建一个数组。
#include<stdio.h>
int * createArray ( int size )
{
int array[size];
return 0;
}
一个create_array.h文件(根据我对FFI的理解,你需要将你的c函数放在一个c库中。):
int * createArray ( int size )
这是我的 dynamic_array.rb 文件,可以按以下方式执行某些操作:
require 'ffi'
class DynamicArray
extend FFI::Library
ffi_lib "./create_array.h"
attach_function :create_array, [:int], :int
def initialize
@size = 0
@capacity = 1
@current_index = 0
@static_array = create_array(@capacity)
end
def add(element)
@size += 1
resize_array if @size > @capacity
@static_array[@current_index] = element
@current_index += 1
end
private
def resize_array
@capacity = @capacity*2
new_arr = create_array(@capacity)
@static_array.each_with_index do |val, index|
new_arr[index] = val
end
@static_array = new_arr
end
end
以下是添加和调整大小的一些测试:
def test_add
dynamic_arr = DynamicArray.new
dynamic_arr.add(1)
dynamic_arr.add(2)
assert_equal(1, dynamic_arr.static_array[0])
assert_equal(2, dynamic_arr.static_array[1])
end
def test_resize_array
dynamic_arr = DynamicArray.new
dynamic_arr.add(1)
dynamic_arr.add(2)
assert_equal(2, dynamic_arr.capacity)
dynamic_arr.resize_array
assert_equal(4, dynamic_arr.capacity)
assert_equal
end
你能解释一下我应该怎么做才能完成这项工作吗?
您问题中的以下函数不会分配您想要的数组:
#include<stdio.h>
int * createArray ( int size )
{
int array[size];
return 0;
}
你写的函数中的数组对象是自动分配到栈上的,一旦函数执行完就会自动销毁returns。事实上,因为它没有被使用,C 编译器可能会优化数组。
您可能希望做的是:
VALUE * create_array(size_t size) {
VALUE * a = calloc(size, sizeof(*a));
return a;
}
现在,返回的 a
是一个 VALUE
的数组(或者,从技术上讲,是指向数组第一个成员的指针)。
VALUE
是 Ruby 对象的 C 等效项(通常这将映射到转换为 unsigned long
的标记指针)。
调整大小可以使用realloc
,它会自动将现有数据复制到新内存(或数组):
VALUE * tmp = realloc(tmp, new_size * sizeof(*a));
if(!tmp) {
/* deal with error, print message, whatever... */
free(a);
exit(-1);
}
a = tmp;
您仍然需要使用 FFI 将 C 代码连接到 Ruby 层,但这应该可以回答您关于如何调整数组大小的问题(并解决您创建数组的错误)。
注意:对于大分配,realloc 可以优化复制阶段,这在大型数组中非常有益,并且具有显着的积极性能影响。这可以通过利用内存地址是虚拟的并且不必映射到连续的内存段这一事实来执行。即,同一内存页可以接收新地址作为新分配的一部分。
看来您没有正确使用 C 代码。
在create_array
C函数中:
- 您没有 return 数组,因此 ruby 代码无法与新创建的数组一起使用,您需要 return 它
- 如果你想要return一个数组你实际上需要return它是指针
- 在 C 中,为了创建一个数组并且在编译之前不知道大小,您需要使用
malloc
(或 alloc
系列中的其他函数)分配它的内存
将它们放在一起,这就是您的 create_array.c
文件的样子:
#include <stdlib.h> /* in order to use malloc */
int * create_array (int size){
int *a = malloc(size * sizeof(int));
return a; /* returning the pointer to the array a*/
}
和你的头文件create_array.h
:
int * create_array(int);
为了把所有东西都包起来,你仍然需要在 ruby 可以触摸它之前编译它:
gcc -shared -o create_array.so -fPIC create_array.c
此命令使用 gcc 将您的 C 代码从 create_array.c
源文件编译到名为 create_array.so
的共享库中。需要安装 gcc 才能工作。
您终于可以使用 ruby 中的 C 函数,并在您的 dynamic_array.rb
:
中进行一些修改
require 'ffi'
class DynamicArray
extend FFI::Library
ffi_lib "./create_array.so" # using the shared lib
attach_function :create_array, [:int], :pointer # receiving a pointer to the array
# rest of your code
现在,这应该可以了!
但是您的 ruby 代码仍然存在一些问题:
- 当您执行
@static_array = create_array(@capacity)
时,您收到的是指向已分配数组的 C 指针,而不是数组本身,至少在 ruby. 中不是
- 写
@static_array[@current_index] = element
不行NoMethodError: undefined method '[]=' for #<FFI::Pointer address=0x000055d50e798600>
- 如果要向数组中添加一个元素,必须用 C 代码来完成。类似于:
void add_to_array (int * array, int index, int number){
array[index] = number;
}
attach_function :add_to_array, [:pointer, :int, :int], :void
add_to_array(@static_array, @current_index, element)
- 同样适用于
@static_array.each_with_index
你需要用 C 编写代码。
我想在 ruby 中创建自己的动态数组 class(作为训练)。 这个想法是让 class DynamicArray 具有容量(它在给定时刻可以容纳的元素数量)、大小(在给定时刻实际推入数组的元素数量)和a static_array 这是一个固定大小的静态整数数组。每当此 static_array 已满时,我们将创建一个容量为原始 static_array 两倍的新静态数组,并复制新 static_array 中的每个元素。 由于 ruby 中没有静态数组,我的想法是使用 FFI https://github.com/ffi/ffi。在 c 中创建一个函数,该函数创建一个大小为 n 的静态 int 数组,然后能够在我的 ruby 程序中使用它。 我对 C 知之甚少,很难理解 FFI 的文档 这是我目前所拥有的,一个 create_array.c 文件,它定义了我的 c 函数来创建一个数组。
#include<stdio.h>
int * createArray ( int size )
{
int array[size];
return 0;
}
一个create_array.h文件(根据我对FFI的理解,你需要将你的c函数放在一个c库中。):
int * createArray ( int size )
这是我的 dynamic_array.rb 文件,可以按以下方式执行某些操作:
require 'ffi'
class DynamicArray
extend FFI::Library
ffi_lib "./create_array.h"
attach_function :create_array, [:int], :int
def initialize
@size = 0
@capacity = 1
@current_index = 0
@static_array = create_array(@capacity)
end
def add(element)
@size += 1
resize_array if @size > @capacity
@static_array[@current_index] = element
@current_index += 1
end
private
def resize_array
@capacity = @capacity*2
new_arr = create_array(@capacity)
@static_array.each_with_index do |val, index|
new_arr[index] = val
end
@static_array = new_arr
end
end
以下是添加和调整大小的一些测试:
def test_add
dynamic_arr = DynamicArray.new
dynamic_arr.add(1)
dynamic_arr.add(2)
assert_equal(1, dynamic_arr.static_array[0])
assert_equal(2, dynamic_arr.static_array[1])
end
def test_resize_array
dynamic_arr = DynamicArray.new
dynamic_arr.add(1)
dynamic_arr.add(2)
assert_equal(2, dynamic_arr.capacity)
dynamic_arr.resize_array
assert_equal(4, dynamic_arr.capacity)
assert_equal
end
你能解释一下我应该怎么做才能完成这项工作吗?
您问题中的以下函数不会分配您想要的数组:
#include<stdio.h>
int * createArray ( int size )
{
int array[size];
return 0;
}
你写的函数中的数组对象是自动分配到栈上的,一旦函数执行完就会自动销毁returns。事实上,因为它没有被使用,C 编译器可能会优化数组。
您可能希望做的是:
VALUE * create_array(size_t size) {
VALUE * a = calloc(size, sizeof(*a));
return a;
}
现在,返回的 a
是一个 VALUE
的数组(或者,从技术上讲,是指向数组第一个成员的指针)。
VALUE
是 Ruby 对象的 C 等效项(通常这将映射到转换为 unsigned long
的标记指针)。
调整大小可以使用realloc
,它会自动将现有数据复制到新内存(或数组):
VALUE * tmp = realloc(tmp, new_size * sizeof(*a));
if(!tmp) {
/* deal with error, print message, whatever... */
free(a);
exit(-1);
}
a = tmp;
您仍然需要使用 FFI 将 C 代码连接到 Ruby 层,但这应该可以回答您关于如何调整数组大小的问题(并解决您创建数组的错误)。
注意:对于大分配,realloc 可以优化复制阶段,这在大型数组中非常有益,并且具有显着的积极性能影响。这可以通过利用内存地址是虚拟的并且不必映射到连续的内存段这一事实来执行。即,同一内存页可以接收新地址作为新分配的一部分。
看来您没有正确使用 C 代码。
在create_array
C函数中:
- 您没有 return 数组,因此 ruby 代码无法与新创建的数组一起使用,您需要 return 它
- 如果你想要return一个数组你实际上需要return它是指针
- 在 C 中,为了创建一个数组并且在编译之前不知道大小,您需要使用
malloc
(或alloc
系列中的其他函数)分配它的内存
将它们放在一起,这就是您的 create_array.c
文件的样子:
#include <stdlib.h> /* in order to use malloc */
int * create_array (int size){
int *a = malloc(size * sizeof(int));
return a; /* returning the pointer to the array a*/
}
和你的头文件create_array.h
:
int * create_array(int);
为了把所有东西都包起来,你仍然需要在 ruby 可以触摸它之前编译它:
gcc -shared -o create_array.so -fPIC create_array.c
此命令使用 gcc 将您的 C 代码从 create_array.c
源文件编译到名为 create_array.so
的共享库中。需要安装 gcc 才能工作。
您终于可以使用 ruby 中的 C 函数,并在您的 dynamic_array.rb
:
require 'ffi'
class DynamicArray
extend FFI::Library
ffi_lib "./create_array.so" # using the shared lib
attach_function :create_array, [:int], :pointer # receiving a pointer to the array
# rest of your code
现在,这应该可以了! 但是您的 ruby 代码仍然存在一些问题:
- 当您执行
@static_array = create_array(@capacity)
时,您收到的是指向已分配数组的 C 指针,而不是数组本身,至少在 ruby. 中不是
- 写
@static_array[@current_index] = element
不行NoMethodError: undefined method '[]=' for #<FFI::Pointer address=0x000055d50e798600>
- 如果要向数组中添加一个元素,必须用 C 代码来完成。类似于:
void add_to_array (int * array, int index, int number){
array[index] = number;
}
attach_function :add_to_array, [:pointer, :int, :int], :void
add_to_array(@static_array, @current_index, element)
- 同样适用于
@static_array.each_with_index
你需要用 C 编写代码。