remove_objRemoveObjRemoveObjremove_objremove_obj🔗

Short description🔗

remove_objRemoveObjRemoveObjremove_objremove_obj — Remove objects from an iconic object tuple.

Signature🔗

remove_obj( object Objects, out object ObjectsReduced, number Index )

HObject HObject.RemoveObj( int index )

HImage HImage.RemoveObj( HTuple index )

HImage HImage.RemoveObj( int index )

HRegion HRegion.RemoveObj( int index )

HXLD HXLD.RemoveObj( HTuple index )

HXLD HXLD.RemoveObj( int index )

Description🔗

remove_objRemoveObj removes the elements referred by Indexindexindex from the tuple Objectsobjectsobjects and returns the rest in the tuple ObjectsReducedobjectsReducedobjects_reduced. Indexindexindex determines the index of the elements to remove. Note that, in contrast to control tuples, indices for the object tuple elements start at 1, i.e. the first tuple element has got the index 1. Duplicates and indices out of range are ignored.

Execution information🔗

Execution information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).

Parameters🔗

Objectsobjectsobjects (input_object) object(-array) → objectHObjectHObjectHObjectHobject

Input object tuple.

ObjectsReducedobjectsReducedobjects_reduced (output_object) object(-array) → objectHObjectHObjectHObjectHobject *

Remaining object tuple.

Indexindexindex (input_control) number(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Indices of the objects to be removed.

Example🔗

(HDevelop)

gen_empty_obj (Images)
for Index := 1 to 10 by 1
  gen_image_const (Image, 'byte', Index, Index)
  concat_obj (Images, Image, Images)
endfor

remove_obj (Images, Images, [7, 4])

Combinations with other operators🔗

Combinations

Alternatives

select_objSelectObj

Module🔗

Foundation