mruby/c Array class More...

#include "mrubyc.h"
#include "_autogen_class_array.h"

Include dependency graph for c_array.c:

Functions
mrbc_value	mrbc_array_new (mrbc_vm *vm, int size)
void	mrbc_array_delete (mrbc_value *ary)
int	mrbc_array_resize (mrbc_value *ary, int size)
int	mrbc_array_set (mrbc_value ary, int idx, mrbc_value set_val)
mrbc_value	mrbc_array_get (const mrbc_value *ary, int idx)
mrbc_value *	mrbc_array_get_p (const mrbc_value *ary, int idx)
int	mrbc_array_push (mrbc_value ary, mrbc_value set_val)
int	mrbc_array_push_m (mrbc_value ary, mrbc_value set_val)
mrbc_value	mrbc_array_pop (mrbc_value *ary)
int	mrbc_array_unshift (mrbc_value ary, mrbc_value set_val)
mrbc_value	mrbc_array_shift (mrbc_value *ary)
int	mrbc_array_insert (mrbc_value ary, int idx, mrbc_value set_val)
mrbc_value	mrbc_array_remove (mrbc_value *ary, int idx)
void	mrbc_array_clear (mrbc_value *ary)
int	mrbc_array_compare (const mrbc_value v1, const mrbc_value v2)
void	mrbc_array_minmax (mrbc_value ary, mrbc_value pp_min_value, mrbc_value *pp_max_value)
mrbc_value	mrbc_array_dup (mrbc_vm vm, const mrbc_value ary)
mrbc_value	mrbc_array_divide (mrbc_vm vm, mrbc_value src, int pos)
int	mrbc_array_index (const mrbc_value ary, const mrbc_value val)
mrbc_value	mrbc_array_uniq (mrbc_vm vm, const mrbc_value ary)
int	mrbc_array_uniq_self (mrbc_value *ary)

Detailed Description

mruby/c Array class

  Copyright (C) 2015-      Kyushu Institute of Technology.
  Copyright (C) 2015-2026  Shimane IT Open-Innovation Center.
  Copyright (C) 2026-      Shimane Institute for Industrial Technology.

  This file is distributed under BSD 3-Clause License.


 Function summary

 (constructor)
    mrbc_array_new()

 (destructor)
    mrbc_array_delete()

 (setter)
  --[name]-------------[arg]---[ret]-------------------------------------------
    mrbc_array_set()     *V     int
    mrbc_array_push()    *V     int
    mrbc_array_push_m()  *V     int
    mrbc_array_unshift() *V     int
    mrbc_array_insert()  *V     int

 (getter)
  --[name]-------------[arg]---[ret]---[note]----------------------------------
    mrbc_array_get()    idx      V      Data remains in the container
    mrbc_array_get_p()  idx     *V      Data remains in the container
    mrbc_array_pop()             V      Data does not remain in the container
    mrbc_array_shift()           V      Data does not remain in the container
    mrbc_array_remove() idx      V      Data does not remain in the container

 (finder)
    mrbc_array_index()
    mrbc_array_include()

 (others)
    mrbc_array_size()
    mrbc_array_resize()
    mrbc_array_clear()
    mrbc_array_compare()
    mrbc_array_minmax()
    mrbc_array_dup()
    mrbc_array_divide()
    mrbc_array_uniq()
    mrbc_array_uniq_self()

Definition in file c_array.c.

Function Documentation

◆ mrbc_array_clear()

void mrbc_array_clear ( mrbc_value * ary )

clear all

Parameters

ary	pointer to target value

Definition at line 409 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_compare()

int mrbc_array_compare	(	const mrbc_value *	v1,
		const mrbc_value *	v2 )

compare

Parameters

v1	Pointer to mrbc_value
v2	Pointer to another mrbc_value

Return values

0	v1 == v2
plus	v1 > v2
minus	v1 < v2

Definition at line 432 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_delete()

void mrbc_array_delete ( mrbc_value * ary )

destructor

Parameters

ary	pointer to target value

Definition at line 105 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_divide()

mrbc_value mrbc_array_divide	(	mrbc_vm *	vm,
		mrbc_value *	src,
		int	pos )

divide into two parts

Parameters

vm	pointer to VM.
src	source
pos	divide position

Returns: divided array

Note: src = [0,1,2,3] ret = divide(src, 2) src = [0,1], ret = [2,3]

Definition at line 516 of file c_array.c.

Here is the call graph for this function:

◆ mrbc_array_dup()

mrbc_value mrbc_array_dup	(	mrbc_vm *	vm,
		const mrbc_value *	ary )

duplicate (shallow copy)

Parameters

vm	pointer to VM.
ary	source

Returns: result

Definition at line 486 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_get()

mrbc_value mrbc_array_get	(	const mrbc_value *	ary,
		int	idx )

getter

Parameters

ary	pointer to target value
idx	index

Returns: mrbc_value data at index position or Nil.

Definition at line 207 of file c_array.c.

Here is the caller graph for this function:

◆ mrbc_array_get_p()

mrbc_value * mrbc_array_get_p	(	const mrbc_value *	ary,
		int	idx )

getter

Parameters

ary	pointer to target value
idx	index

Returns: pointer to mrbc_value or NULL.

Definition at line 225 of file c_array.c.

◆ mrbc_array_index()

int mrbc_array_index	(	const mrbc_value *	ary,
		const mrbc_value *	val )

index

Parameters

ary	target array.
val	search object.

Returns: index value or -1 if not found.

Definition at line 541 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_insert()

int mrbc_array_insert	(	mrbc_value *	ary,
		int	idx,
		mrbc_value *	set_val )

insert a data

Parameters

ary	pointer to target value
idx	index
set_val	set value

Returns: mrbc_error_code

Definition at line 337 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_minmax()

void mrbc_array_minmax	(	mrbc_value *	ary,
		mrbc_value **	pp_min_value,
		mrbc_value **	pp_max_value )

get min, max value

Parameters

ary	pointer to target value
pp_min_value	returns minimum mrbc_value
pp_max_value	returns maxmum mrbc_value

Definition at line 452 of file c_array.c.

Here is the call graph for this function:

◆ mrbc_array_new()

mrbc_value mrbc_array_new	(	mrbc_vm *	vm,
		int	size )

constructor

Parameters

vm	pointer to VM.
size	initial size

Returns: array object

Definition at line 83 of file c_array.c.

Here is the caller graph for this function:

◆ mrbc_array_pop()

mrbc_value mrbc_array_pop ( mrbc_value * ary )

pop a data from tail.

Parameters

ary	pointer to target value

Returns: tail data or Nil

Definition at line 288 of file c_array.c.

◆ mrbc_array_push()

int mrbc_array_push	(	mrbc_value *	ary,
		mrbc_value *	set_val )

push a data to tail

Parameters

ary	pointer to target value
set_val	set value

Returns: mrbc_error_code

Definition at line 243 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_push_m()

int mrbc_array_push_m	(	mrbc_value *	ary,
		mrbc_value *	set_val )

push multiple data to tail

Parameters

ary	pointer to target value
set_val	set value (array)

Returns: mrbc_error_code

Definition at line 264 of file c_array.c.

Here is the call graph for this function:

◆ mrbc_array_remove()

mrbc_value mrbc_array_remove	(	mrbc_value *	ary,
		int	idx )

remove a data

Parameters

ary	pointer to target value
idx	index

Returns: mrbc_value data at index position or Nil.

Definition at line 386 of file c_array.c.

◆ mrbc_array_resize()

int mrbc_array_resize	(	mrbc_value *	ary,
		int	size )

resize buffer

Parameters

ary	pointer to target value
size	size

Returns: mrbc_error_code

Definition at line 147 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_set()

int mrbc_array_set	(	mrbc_value *	ary,
		int	idx,
		mrbc_value *	set_val )

setter

Parameters

ary	pointer to target value
idx	index
set_val	set value

Returns: mrbc_error_code

Definition at line 169 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_shift()

mrbc_value mrbc_array_shift ( mrbc_value * ary )

removes the first data and returns it.

Parameters

ary	pointer to target value

Returns: first data or Nil

Definition at line 316 of file c_array.c.

◆ mrbc_array_uniq()

mrbc_value mrbc_array_uniq	(	mrbc_vm *	vm,
		const mrbc_value *	ary )

removes duplicate elements and return allocated new mrbc_value

Parameters

vm	pointer to VM.
ary	source

Returns: result

Definition at line 558 of file c_array.c.

Here is the call graph for this function:

◆ mrbc_array_uniq_self()

int mrbc_array_uniq_self ( mrbc_value * ary )

removes duplicate elements

Parameters

ary target

Returns: num of deleted

Definition at line 573 of file c_array.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mrbc_array_unshift()

int mrbc_array_unshift	(	mrbc_value *	ary,
		mrbc_value *	set_val )

insert a data to the first.

Parameters

ary	pointer to target value
set_val	set value

Returns: mrbc_error_code

Definition at line 304 of file c_array.c.

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ mrbc_array_clear()

◆ mrbc_array_compare()

◆ mrbc_array_delete()

◆ mrbc_array_divide()

◆ mrbc_array_dup()

◆ mrbc_array_get()

◆ mrbc_array_get_p()

◆ mrbc_array_index()

◆ mrbc_array_insert()

◆ mrbc_array_minmax()

◆ mrbc_array_new()

◆ mrbc_array_pop()

◆ mrbc_array_push()

◆ mrbc_array_push_m()

◆ mrbc_array_remove()

◆ mrbc_array_resize()

◆ mrbc_array_set()

◆ mrbc_array_shift()

◆ mrbc_array_uniq()

◆ mrbc_array_uniq_self()

◆ mrbc_array_unshift()