Kotlin/Array
الدوال البانية
<int>
يعيد التابع Any()
نسخةً من الصنف Any
والذي هو الجذر الرئيسيّ في الهرميّة العامّة لأيّ صنفٍ مُستخدَمٍ أثناء البرمجة في Kotlin؛ أي أنّ كلَّ صنفٍ سيكون له الصنف الأعلى (superclass) Any
.
الدوال والخاصيات
size
تمثِّل الخاصيّة size
عدد العناصر الموجودة في المصفوفة (array).
iterator
يعيد التابع Array.iterator()
عنصرًا تكراريًّا (iterator) بهدف تطبيق حلقة تكرار (loop) برمجيةٍ على كافّة عناصر المصفوفة.
get
يعيد التابع Array.get()
قيمة عنصر محدد بعد تمرير فهرسه (index) إليه. يمكن أيضًا استدعاء هذا التابع باستخدام معامل الفهرسة (index operator) المتمثل بالقوسين []
.
الدوال الموروثة
equals
تحدد الدالة equals()
إذا ما كان الكائن المُمرّر إليها يساوي الكائن الذي استدعيت عبره.
hashCode
يعيد التابع hashCode()
قيمة الشيفرة Hash الخاصّة بالكائن الذي استُدعي عبره.
toString
يحول التابع toString()
الكائن الذي يُستدعى عبره إلى سلسلة نصية.
الخاصيات الإضافية (Extension Properties)
indices
تُستخدَم هذه الخاصيّة للحصول على الفهارس الصحيحة (valid indices) للمصفوفة أو المجموعة (collection).
lastIndex
تُستخدَم هذه الخاصيّة للحصول على الفهرس (index) الأخير للمصفوفة أو القائمة (list).
الدوال الإضافية (Extension Functions)
all
تُعيد الدالة all()
القيمة true
إن كانت كافّة عناصر المصفوفة أو المجموعة (collection) التي استُدعيت عبرها تُحقِّق العبارة المنطقية (predicate) المُحدَّدة، أو تعيد القيمة false
بخلاف ذلك.
any
يختلف سلوك الدالة any()
بحسب طريقة استدعائها، وسنناقش هذه الحالات تباعًا.
asIterable
تُنشئ الدالة asIterable()
نسخة تكرارية (Iterable instance) والتي تُغلّف المصفوفة الأصلية وتعيد عناصرها عندما تُستخدم في حلقات التكرار (مثل for
).
asList
تُعيد الدالة asList()
قائمة (list) تُغلّف المصفوفة الأصلية التي استُدعيت عبرها.
asSequence
تُنشئ الدالة asSequence()
نسخةً من الواجهة Sequence
التي تُغلّف المصفوفة الأصلية وتعيد عناصرها عندما تُستخدم في حلقات التكرار (مثل for
).
associate
تعيد الدالة associate()
خريطة (map) يحتوي أزواجًا "مفتاح-قيمة" ناتجة عن تمرير عناصر المصفوفة أو المجموعة (Collection) إلى الدالة transform
.
associateBy
تعيد الدالة associateBy()
خريطةً (map) تحتوي على عناصر المصفوفة أو المجموعة (Collection) المعطاة مفهرسةً بقيمة المفتاح المعاد من تمرير تلك العناصر إلى الدالةvalueTransform
.
associateByTo
تعيد الدالة associateByTo()
خريطةً متغيرةً (mutable map) تحتوي على أزواج من "قيمة/مفتاح"، إذ القيمة هي عناصر المصفوفة أو المجموعة (Collection) المعطاة، والمفتاح هو الناتج المعاد من تمرير تلك العناصر إلى الدالة keySelector
.
associateTo
تعيد الدالة associateTo()
خريطةً متغيرةً (mutable map) تحتوي على أزواج من "قيمة/مفتاح"، إذ القيمة هي عناصر المصفوفة أو المجموعة (Collection) المعطاة، والمفتاح هو الناتج المعاد من تمرير تلك العناصر إلى الدالة transform
.
average
تحسب الدالة average()
متوسط (average) عناصر المصفوفة أو المجموعة (Collection) المعطاة لها.
binarySearch
تبحث الدالة binarySearch()
عن عنصر معين في المجموعة أو مجال من المجموعة (Collection) باستخدام خوارزميَّة البحث الثنائي (binary search algorithm) وتعيد فهرس موقعه.
component1
تعيد الدالة component1()
العنصر الأول من المصفوفة التي استُدعيت عبرها، وفي حال استُدعيت عبر قاموس فستعيد مركبة المفتاح (key component) الخاصة بمدخل القاموس (map entry)، وتسمح هذه الدالة باستخدام التصريحات التفكيكية (destructuring declarations) عند العمل على القواميس.
contains
تعيد الدالة contains()
القيمة true
إن كانت المصفوفة أو المجموعة التي استُدعيت عبرها تحتوي العنصر الممرّر إليها، وفي حال استُدعيت عبر قاموس فتعيد true
إن كان ذلك القاموس يحتوي ذلك العنصر كمفتاح (key
)، وتعيد false
خلاف ذلك.
contentDeepEquals
تعيد الدالة contentDeepEquals()
القيمة true
إن كانت المصفوفتان المحددتان متساويتان بعُمق، أي أنهما تحتويان على نفس عدد العناصر ونفس العناصر بنفس الترتيب، وتعيد false
خلاف ذلك.
contentDeepHashCode
تعيد الدالة contentDeepHashCode()
التكويد (hash code) استنادًا إلى محتوى المصفوفة التي استُدعيت عبرها كما لو كانت لائحة، المصفوفاتالمُتشعبة تعامل كاللوائح هي كذلك.
contentDeepToString
تعيد الدالةcontentDeepToString()
تمثيلًا نصيًا لمحتوى المصفوفة التي استُدعيت عبرها كما لو كانت لائحة، المصفوفات المُتشعبة تعامل كاللوائح هي كذلك.
contentEquals
تعيد الدالة contentEquals()
االقيمة true
إن كانت المصفوفتان المحددتان متساويتان بنيويًا (structurally equal)، أي أنهما تحتويان على نفس عدد العناصر ونفس العناصر بنفس الترتيب، وتعيد false
خلاف ذلك.
contentHashCode
تعيد الدالة contentHashCode()
التكويد (hash code) استنادًا إلى محتوى المصفوفة التي استُدعيت عبرها كما لو كانت لائحة.
contentToString
تعيد الدالةcontentToString()
تمثيلًا نصيًا لمحتوى المصفوفة التي استُدعيت عبرها كما لو كانت لائحة.
copyOf
تعيد الدالةcopyOf()
نسخة من المصفوفة التي استُدعيت عبرها. مع إمكانية تمرير newSize
كمعامل (parameter) لتحديد حجم المصفوفة الناتجة.
copyOfRange
تعيد الدالةcopyOfRange()
مصفوفة جديدة، والتي هي نسخة من مجال (range) من المصفوفة التي استُدعيت عبرها.
count
تعيد الدالةcount()
عدد عناصر المصفوفة أو المجموعة أو القاموس التي استُدعيت عبرها، مع إمكانية تمرير دالة منطقية (predicate
) كمعامل (parameter)، وحينها ستعيد عدد العناصر التي تحقق الدالة المنطقية predicate
.
distinct
تعيد الدالةdistinct()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي استُدعيت عبرها بدون تكرار مع احترام ظهور تلك العناصر في المصفوفة أوالمجموعة.
distinctBy
تعيد الدالةdistinctBy()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي استُدعيت عبرها والتي تختلف نتائج تطبيق الدالة (selector
) عليها، ومع احترام ظهور تلك العناصر في المصفوفة أوالمجموعة.
drop
تعيد الدالةdrop()
لائحة تحتوي جميع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها باستثناء العناصر الأولى المحددة بالمعامل المُمرّر n
.
dropLast
تعيد الدالةdropLast()
لائحة تحتوي جميع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها باستثناء العناصر الأخيرة المحددة بالمعامل المُمرّر n
.
dropLastWhile
تعيد الدالةdropLastWhile()
لائحة تحتوي جميع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها باستثناء العناصر الأخيرة التي تحقق الشرط المنطقي predicate
المُمرّر إلى الدالة.
dropWhile
تعيد الدالةdropWhile()
لائحة تحتوي جميع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها باستثناء العناصر الأولى التي تحقق الشرط المنطقيpredicate
المُمرّر إلى الدالة.
elementAt
تعيد الدالةelementAt()
العنصر الموجود عند الفهرس (index) المحدد من المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال كان ذلك الفهرس خارج حدود المصفوفة أو المجموعة فستُطلق استثناءً IndexOutOfBoundsException.
elementAtOrElse
تعيد الدالةelementAtOrElse()
العنصر الموجود عند الفهرس (index) المحدد من المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال كان ذلك الفهرس خارج حدود المصفوفة أو المجموعة فستُعيد ناتج تطبيق الدالة المُمرّرة defaultValue()
على الفهرس.
elementAtOrNull
تعيد الدالةelementAtOrNull()
العنصر الموجود عند الفهرس (index) المحدد من المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال كان ذلك الفهرس خارج حدود المصفوفة أو المجموعة فستُعيد القيمة المعدومة null
.
fill
تعيّن الدالةfill()
قيمة العناصر الموجودة في الفهارس المحددة للمصفوفة أو اللائحة التي استُدعيت عبرها وتعطيها القيمة الممررة إليها.
filter
تعيد الدالةfilter()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي تحقق الشرط المنطقي predicate()
المُمرّر إلى الدالة. وفي حال استدعائها عبرقاموس فستعيد قاموسًا جديدًا مكونًا من كل الأزوج التي تحقق الشرط المنطقي predicate()
الممرر إلى الدالة، هذا القاموسالجديد يحافظ على ترتيب تكرار (entry iteration order) القاموسالأصلي.
filterIndexed
تعيد الدالةfilterIndexed()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي تحقق الشرط المنطقي predicate()
المُمرّر إلى الدالة، الدالة المنطقية predicate()
تأخذ فهرس العنصر وقيمته كمعامل وتعيد قيمة منطقية.
filterIndexedTo
تضيف الدالةfilterIndexedTo()
إلى المعامل destination
الممرّر إليها عناصرّ المجموعة المتغيرة (MutableCollection
) التي استُدعيت عبرها والتي تحقق الشرط المنطقي predicate()
المُمرّر إلى الدالة، الدالة المنطقية predicate()
تأخذ فهرس العنصر وقيمته كمعاملَين وتعيد قيمة منطقية.
filterIsInstance
تعيد الدالةfilterIsInstance()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي استُدعيت عبرها والتي هي نسخة (instance) من نوع (type) أوصنفٍ معيّن.
filterIsInstanceTo
تضيف الدالةfilterIsInstanceTo()
عناصر المصفوفة أو المجموعة التي استُدعيت عبرها و التي هي نسخة (instance) من نوع (type) أو صنفٍمعيّن إلى المجموعة المتغيرة destination
المُمرّرة إليها.
filterNot
تعيد الدالةfilterNot()
لائحة تحتوي عناصر المصفوفة أو المجموعة التي لا تحقق الشرط المنطقي predicate()
المُمرّر إلى الدالة. وفي حال استدعائها عبر قاموس فستعيد قاموسًا جديدًا مكونًا من كل الأزوج التي لا تحقق الشرط المنطقي predicate()
الممرر إلى الدالة، هذا القاموسالجديد يحافظ على ترتيب تكرار (entry iteration order) القاموسالأصلي.
filterNotNull
تعيد الدالةfilterNotNull()
لائحة تحتوي عناصر المصفوفة أو المجموعة غير المعدومة، أي التي تخالف قيمتها null
.
filterNotNullTo
تضيف الدالةfilterNotNullTo()
إلى المعامل destination
الممرّر إليها عناصرّ المصفوفة أو المجموعة التي استُدعيت عبرها والتي تخالف قيمتها القيمة null
. من الجدير بالذكر أنّ destination
ينبغي أن تكون مجموعة قابلة للتغيير (MutableCollection
).
filterNotTo
تضيف الدالةfilterNotTo()
إلى المعامل destination
الممرّر إليها عناصرّ المصفوفة أو المجموعة التي استُدعيت عبرها والتي لا تحقق الشرط المنطقي predicate
المُمرّر إليها. من الجدير بالذكر أنّ destination
ينبغي أن تكون مجموعة قابلة للتغيير (MutableCollection
).
في حال استدعائها عبر قاموس فستضيف كل الأزوج التي لا تحقق الشرط المنطقي predicate()
إلى القاموس destination
الممرّر إليها. ومن الجدير بالذكر أنّ destination
ينبغي أن تكون قاموسًا قابلا للتغيير (MutableMap
).
filterTo
تضيف الدالةfilterTo()
إلى المعامل destination
الممرّر إليها عناصرّ المصفوفة أو المجموعة التي استُدعيت عبرها والتي تحقق الشرط المنطقيpredicate
المُمرّر إليها. من الجدير بالذكر أنّ destination
ينبغي أن تكون مجموعة قابلة للتغيير (MutableCollection
).
في حال استدعائها عبر قاموس فستضيف كل الأزوج التي تحقق الشرط المنطقي predicate()
إلى القاموس destination
الممرّر إليها. ومن الجدير بالذكر أنّ destination
ينبغي أن تكون قاموسًا قابلا للتغيير (MutableMap
).
find
تعيد الدالةfind()
العنصر الأول من المصفوفة أو المجموعة التي استُدعيت عبرها والذي يحقق الشرط المنطقي predicate
المُمرّر إليها. وإن لم يكن هناك أي عنصر يحقق ذلك فستعيد null.
findLast
تعيد الدالةfindLast()
العنصر الأخير من المصفوفة أو المجموعة التي استُدعيت عبرها والذي يحقق الشرط المنطقي predicate
المُمرّر إليها. وإن لم يكن هناك أي عنصر يحقق ذلك فستعيد null.
first
تعيد الدالةfirst()
العنصر الأول من المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال تمرير دالة منطقية كمعامل فستعيد أول عنصر يحقق تلك الدالة.
إن كانت المصفوفة أو المجموعة التي استُدعيت الدالةfirst()
عبرها فارغة أو لم يكن هناك أي عنصر يحقق الدالة المنطقية الممررة إليها فستطلق الدالة الاستثناء NoSuchElementException
.
firstOrNull
تعيد الدالةfirstOrNull()
العنصر الأول من المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال تمرير دالة منطقية كمعامل فستعيد أول عنصر يحقق تلك الدالة.
flatMap
تعيد الدالةflatMap()
لائحة تضم ناتج تطبيق الدالة transform()
المُمرّرة إليها على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال استدعاء الدالة flatMap()
على قاموس فستعيد لائحة تضم ناتج تطبيق الدالة transform()
على مداخل (entries) القاموس.
flatMapTo
تضيف الدالةflatMapTo()
إلى اللائحة المُتغيرة (MutableCollection
) destination
المُمرّرة إليها ناتج تطبيق الدالة transform()
على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال استدعاء الدالة flatMapTo()
على قاموس فستضيف إلى اللائحة destination
ناتج تطبيق الدالة transform()
على مداخل (entries) القاموس.
flatten
تعيد الدالةflatten()
لائحة تحتوي جميع عناصر المصفوفات أو المجموعات التي تنتمي إلى المصفوفة أو المجموعة التي استُدعيت عبرها.
fold
يختلف سلوك الدالةfold()
حسب نوع الكائنات التي استُدعيت عبرها و نوع المعاملات (parameters) المُمرّرة إليها (انظر فقرة البنية العامة).
foldIndexed
تُراكِم الدالةfoldIndexed()
القيم بدءًا من القيمة المُمرّرة initial
وتطبّق العملية operation
من اليسار إلى اليمين على القيمة المُتراكمة الراهنة وعلى العنصر التالي من المصفوفة أو المجموعة التي استُدعيت عبرها وكذلك فهرسه. وتُعيد القيمة النهائية.
foldRight
تُراكِم الدالةfoldRight()
القيم بدءًا من القيمة المُمرّرة initial
وتطبّق العملية operation
من اليمين إلى اليسار على القيمة المُتراكمة الراهنة وعلى العنصر التالي من المصفوفة أو المجموعة التي استُدعيت عبرها. وتُعيد القيمة النهائية.
foldRightIndexed
تُراكِم الدالةfoldRightIndexed()
القيم بدءًا من القيمة المُمرّرة initial
وتطبّق العملية operation
من اليمين إلى اليسار على القيمة المُتراكمة الراهنة وعلى العنصر التالي من المصفوفة أو المجموعة التي استُدعيت عبرها وكذلك فهرسه. وتُعيد القيمة النهائية.
forEach
تُنفّد الدالةُforEach()
الدالةَ المُمرّرةَ action
على كل عناصر المصفوفة أو المجموعة أو القاموس الذي استُدعيت عبره.
forEachIndexed
تُنفّد الدالةُforEachIndexed()
الدالةَ المُمرّرةَ action
على كل عناصر المصفوفة أو المجموعة أو القاموس الذي استُدعيت عبره وعلى فهارسها (indices).
getOrElse
تعيد الدالة getOrElse()
قيمة العنصر عند الفهرس index
المُحدَّد في المصفوفة أو المجموعة التي استُدعيت عبرها. ، أو نتيجة استدعاء الدالة المُمرّرة defaultValue
إن كان الفهرس خارج الحدود.
ان استُدعيت الدالة عبر قاموس فستُعيد القيمة المقابلة للمفتاح key
المُمرّر إلى الدالة، أو نتيجة استدعاء الدالة المُمرّرة defaultValue
إن كان المفتاحkey
موجودًا.
getOrNull
تعيد الدالة getOrNull()
قيمة العنصر عند الفهرس index
المُحدَّد في المصفوفة أو المجموعة التي استُدعيت عبرها. ، أو null
إن كان الفهرس خارج الحدود.
groupBy
تعيد الدالةgroupBy()
قاموسًا يُجمّع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها حيث مفاتيحه تعيدها الدالة المُمرّرة keySelector
وقيمه لوائحُ تضم عناصر المصفوفة أو المجموعة (أو ناتج تمرير عناصر المصفوفة أو المجموعة على الدالة valueTransform
في حال تمريرها).
groupByTo
تجمّع الدالةgroupByTo()
عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وتضيفها إلى القاموس.المُمرّر destination
حيث مفاتيحه تعيدها الدالة الممرّرة keySelector()
مُطبّقة على كل عناصر المصفوفة أو المجموعة، وقيمُه لوائح تضم العناصر المقابلة، وفي حال تمرير معامل ثالثvalueTransform
فإنّ القيم ستكون لوائح تضم ناتج تطبيق الدالة valueTransform
على العناصر المقابلة . ثم تعيد القاموسdestination.
groupingBy
تُنشئ الدالةgroupingBy()
كائنًا من النوع Grouping
من المصفوفة أو المجموعة التي استُدعيت عبرها لاستخدامه لاحقًا مع عمليات المجموعات (group-and-fold operations)، وذلك باستخدام الدالة المُمرّرة keySelector
لاستخلاص مفتاح من كل عنصر .
indexOf
تعيد الدالة indexOf()
فهرس أول ظهور للعنصر المُمرّر إليها في المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها ، أو -1
إن كان العنصر المُمرّر غير موجود.
indexOfFirst
تعيد الدالة indexOfFirst()
فهرس أول ظهور للعنصر المُمرّر إليها في المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها والذي يحقق الشرط المنطقي المُمرّر predicate
، أو -1
إن لم يكن هناك أي عنصر يحقق ذلك.
indexOfLast
تعيد الدالة indexOfLast()
فهرس آخر ظهور للعنصر المُمرّر إليها في المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها والذي يحقق الشرط المنطقي المُمرّر predicate
، أو -1
إن لم يكن هناك أي عنصر يحقق ذلك.
intersect
تعيد الدالة intersect()
مجموعة تحتوي كل العناصر المشتركة بين المصفوفة أو المجموعة التي استُدعيت عبرها وتلك الممرّرة إلى الدالة.
isArrayOf
تتحقق الدالة isArrayOf()
من أنّ المصفوفة التي استُدعيت عبرها يمكن أن تحتوي عناصر من النوع المحدد.
isEmpty
تعيد الدالة isEmpty()
القيمة true
إن كانت المصفوفة التي استُدعيت عبرها فارغةً.
isNotEmpty
تعيد الدالة isNotEmpty()
القيمة true
إن كانت المصفوفة أو المجموعة التي استُدعيت عبرها غير فارغةً.
joinTo
تجمّع الدالةjoinTo()
سلسة نصية من عناصر المصفوفة أو المجموعة التي استُدعيت عبرها مفصولة بالمعامل المُمرّر separator
وباستخدام البادئةprefix
واللاحقة postfix
في حال تمريرهما،
joinToString
تنشئ الدالةjoinToString()
سلسة نصية من عناصر المصفوفة أو المجموعة التي استُدعيت عبرها مفصولة بالمعامل المُمرّر separator
وباستخدام البادئة prefix
واللاحقة postfix
في حال تمريرهما،
last
تعيد الدالةlast()
العنصر الأخير من المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها. في حال تمرير شرط منطقي predicate
كوسيط فستعيد العنصر الأخير الذي يحقق ذلك الشرط.
lastIndexOf
تعيد الدالةlastIndexOf()
آخر فهرس للعنصر الممرّر إلى المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها. وإن لم يكن العنصر موجودًا فستعيد -1
.
lastOrNull
تعيد الدالةlastOrNull()
العنصر الأخير من المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها. في حال تمرير شرط منطقي predicate
كوسيط فستعيد العنصر الأخير الذي يحقق ذلك الشرط.
map
تعيد الدالةmap()
لائحة تضم ناتج تطبيق الدالة transform()
المُمرّرة إليها على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها، وفي حال استدعاء الدالة map()
على قاموس فستعيد لائحة تضم ناتج تطبيق الدالة transform()
على مداخل (entries) القاموس.
mapIndexed
تعيد الدالةmapIndexed()
لائحة تضم ناتج تطبيق الدالة transform()
المُمرّرة إليها على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وعلى فهارسها.
mapIndexedNotNull
تعيد الدالةmapIndexedNotNull()
لائحة تضم فقط النتائج غير المعدومة (non-null
) لتطبيق الدالة transform()
على عناصر المصفوفة أوالمجموعة التي استُدعيت عبرها وعلى فهارسها.
mapIndexedNotNullTo
تطبق الدالةmapIndexedNotNullTo()
الدالة المُمررّة transform()
على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وعلى فهارسها وتضيف فقط النتائج غير المعدومة (non-null
) إلى المعامل الممرّر destination
.
mapIndexedTo
تطبق الدالةmapIndexedTo()
الدالة المُمررّة transform()
على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وعلى فهارسها وتضيف النتائج إلى المعامل الممرّر destination
.
mapNotNull
تعيد الدالةmapNotNull()
لائحة تضم النتائج غير المعدومة (non-null) لتطبيق الدالة transform()
المُمرّرة على عناصر المصفوفة أو المجموعةالتي استُدعيت عبرها، وفي حال استدعاء الدالة mapNotNull()
على قاموس فستعيد لائحة تضم النتائج غير المعدومة (non-null) لتطبيق الدالةtransform()
على مداخل (entries) القاموس.
mapNotNullTo
تطبق الدالةmapNotNullTo()
الدالة المُمررّة transform()
على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وتضيف النتائج غير المعدومة (non-null) إلى المعامل الممرّر destination
. وفي حال استدعاء الدالة mapNotNullTo()
على قاموس فستضيف النتائج غير المعدومة (non-null) لتطبيق الدالةtransform()
على مداخل (entries) القاموس إلى المعامل الممرّر destination
.
mapTo
تطبق الدالةmapTo()
الدالة المُمررّة transform()
على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها وتضيف النتائج إلى المعامل الممرّرdestination
. وفي حال استدعاء الدالة mapTo()
على قاموس فستضيف نتائج تطبيق الدالةtransform()
على مداخل (entries) القاموس إلى المعامل الممرّر destination
.
max
تعيد الدالةmax()
أكبر عنصر في المصفوفة أو المجموعة التي استُدعيت عبرها، أو null
إن كانت فارغة.
maxBy
تعيد الدالةmaxBy()
العنصر الأول في المصفوفة أو المجموعة التي استُدعيت عبره والذي له أكبر قيمة معادة من الدالة الممررة selector
، أو null
إن لم يكن هناك أي عنصر يحقق ذلك.
في حال استدعاء الدالة maxBy()
عبر قاموس فستعيد المدخل (Entry) الأول في ذلك القاموس والذي له أكبر قيمة معادة من الدالة الممررة selector
، أو null
إن لم يكن هناك أي مدخل يحقق ذلك.
maxWith
تعيد الدالةmaxWith()
العنصر الأول في المصفوفة أو المجموعة التي استُدعيت عبره والذي له أكبر قيمة بحسب المقارِن comparator
الممرّر، أو null
إن لم يكن هناك أي عنصر يحقق ذلك.
في حال استدعاء الدالة maxWith()
عبر قاموس فستعيد المدخل (Entry) الأول في ذلك القاموس والذي له أكبر قيمة حسب المقارِن comparator
، أوnull
إن لم يكن هناك أي مدخل يحقق ذلك.
min
تعيد الدالةmin()
أصغر عنصر في المصفوفة أو المجموعة التي استُدعيت عبرها، أو null
إن كانت فارغة.
minBy
تعيد الدالةminBy()
العنصر الأول في المصفوفة أو المجموعة التي استُدعيت عبره والذي له أصغر قيمة معادة من الدالة الممررة selector
، أو null
إن لم يكن هناك أي عنصر يحقق ذلك.
في حال استدعاء الدالة minBy()
عبر قاموس فستعيد المدخل (Entry) الأول في ذلك القاموس والذي له أصغر قيمة معادة من الدالة الممررة selector
، أو null
إن لم يكن هناك أي مدخل يحقق ذلك.
minWith
تعيد الدالةminWith()
العنصر الأول في المصفوفة أو المجموعة التي استُدعيت عبرها والذي له أصغر قيمة بحسب المقارِن comparator
الممرّر، أوnull
إن لم يكن هناك أي عنصر يحقق ذلك.
في حال استدعاء الدالة minWith()
عبر قاموس فستعيد المدخل (Entry) الأول في ذلك القاموس والذي له أصغر قيمة حسب المقارِن comparator
، أوnull
إن لم يكن هناك أي مدخل يحقق ذلك.
none
تعيد الدالةnone()
القيمة true
إن كانت المصفوفة أو المجموعة التي استُدعيت عبرها فارغة، أو تعيد false
. وفي حال تمرير شرط منطقيpredicate
. فستعيد true
إن لم يكن هناك أي عنصر يحقق ذلك الشرط المنطقي، أو تعيد false
.
orEmpty
تعيد الدالةorEmpty()
المصفوفة أو المجموعة أو اللائحة أو القاموس الذي استُدعيت عبره إن لم يكن يساوي null
، أو تعيد مصفوفة أو مجموعة أو لائحةأو قاموسًا فارغًا.
partition
تُقسّم الدالةُpartition()
المصفوفة أو المجموعة التي استُدعيت عبرها إلى زوج مكوّن من لائحتين، اللائحة الأولى تضم العناصر التي تحقق الشرط المنطقي المُمرّر predicate
(أي تعيد true
)، بينما تضم الثانية العناصر الأخرى.
plus
يختلف سلوك الدالة plus()
حسب نوع الكائنات التي استُدعيت عبرها ونوع الوسائط الممررة (انظر فقرة البنية العامة).
plusElement
تضيف الدالة plusElement()
العنصر المُمرّر إلى المصفوفة أو المجموعة التي استُدعيت عبرها.
reduce
يختلف سلوك الدالةreduce()
حسب نوع الكائنات التي استُدعيت عبرها ونوع المعاملات (parameters) المُمرّرة إليها (انظر فقرة البنية العامة).
reduceIndexed
تُراكِم الدالةreduceIndexed()
القيم بدءًا من العنصر الأول في المصفوفة أو المجموعة التي استُدعيت عبرها وتطبّق العملية operation
من اليسار إلى اليمين على القيمة المُتراكمة الراهنة وعلى العنصر الموالي في المصفوفة أو المجموعة التي استُدعيت عبرها وعلى فهرسه. ثم تُعيد القيمة النهائية.
reduceRight
تُراكِم الدالةreduceRight()
القيم بدءًا من العنصر الأخير وتطبّق العملية operation
من اليمين إلى اليسار على العنصر الموالي في المصفوفة أواللائحة التي استُدعيت عبرها وعلى القيمة المُتراكمة الراهنة. ثم تُعيد القيمة النهائية.
reduceRightIndexed
تُراكِم الدالةreduceRightIndexed()
القيم بدءًا من العنصر الأخير في المصفوفة أو اللائحة التي استُدعيت عبرها وتطبّق العملية operation
من اليمين إلى اليسار على القيمة المُتراكمة الراهنة وعلى العنصر الموالي في المصفوفة أو المجموعة التي استُدعيت عبرها وعلى فهرسه. ثم تُعيد القيمة النهائية.
requireNoNulls
تُعيد الدالةrequireNoNulls()
مصفوفة أو مجموعة أو لائحة تضم جميع العناصر غير المعدومة (non-null
) في المصفوفة أو المجموعة أو اللائحةالتي استُدعيت عبرها. في حال كان هناك عنصر معدوم (null
) فستطلق الدالةُrequireNoNulls()
الاستثناء IllegalArgumentException
.
reverse
تعكس الدالةreverse()
ترتيب عناصر المصفوفة أو اللائحة التي استُدعيت عبرها.
reversed
تُعيد الدالةreversed()
لائحة تضم عناصر المصفوفة أو المجموعة التي استُدعيت عبرها بالترتيب المعكوس.
reversedArray
تُعيد الدالةreversedArray()
مصفوفة تضم عناصر المصفوفة التي استُدعيت عبرها بالترتيب المعكوس.
single
تعيد الدالةsingle()
العنصر الوحيد الموجود في المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها، وفي حال تمرير شرط منطقي predicate
كمعامل (parameter) فستعيد العنصر الوحيد الذي يحقق ذلك الشرط المنطقي. أمّا في حال كان الكائن الذي استُدعيت عبره يحتوي أكثر من عنصر واحد (يحقق predicate
في حال تمريرها) أو لا يحتوي أي واحد (يحقق predicate
في حال تمريرها) فستطلق الدالة single()
استثناءً.
singleOrNull
تعيد الدالةsingleOrNull()
العنصر الوحيد الموجود في المصفوفة أو المجموعة أو اللائحة التي استُدعيت عبرها، وفي حال تمرير شرط منطقيpredicate
كمعامل (parameter) فستعيد العنصر الوحيد الذي يحقق ذلك الشرط المنطقي. أمّا في حال كان الكائن الذي استُدعيت عبره يحتوي أكثر من عنصر واحد (يحقق predicate
في حال تمريرها) أو لا يحتوي أي واحد (يحقق predicate
في حال تمريرها) فستعيد القيمة المعدومة null
.
slice
تعيد الدالةslice()
لائحة تحتوي عناصر المصفوفة أو اللائحة التي استُدعيت عبرها والموجودة عند الفهارس التي يحددها الوسيط الممرّر indices
.
sliceArray
تعيد الدالةsliceArray()
لائحة أو مصفوفة تحتوي عناصر المصفوفة التي استُدعيت عبرها والموجودة عند الفهارس التي يحددها الوسيط الممرّرindices
.
sort
تقوم الدالةsort()
بترتيب المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها.
sortBy
تقوم الدالةsortBy()
بترتيب المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها وفقًا للقيم التي تعيدها الدالة المُمرّرة selector
sortByDescending
تقوم الدالةsortByDescending()
بترتيب المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها تنازليًا وفقًا للترتيب الطبيعي للقيم التي تعيدها الدالة المُمرّرة selector
.
sortDescending
تقوم الدالةsortDescending()
بترتيب المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها تنازليًا.
sortWith
تقوم الدالةsortWith()
بترتيب المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها تنازليًا وفقًا للمُقارن المُمرّر comparator
.
sorted
تعيد الدالةsorted()
لائحة تضم عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها مرتبة وفق الترتيب الطبيعي.
sortedArray
تعيد الدالةsortedArray()
مصفوفة تضم عناصر المصفوفة التي استُدعيت عبرها مرتبة وفق الترتيب الطبيعي.
sortedArrayDescending
تعيد الدالةsortedArrayDescending()
مصفوفة تضم عناصر المصفوفة التي استُدعيت عبرها مرتبة ترتيبًا تنازليًا.
sortedArrayWith
تعيد الدالةsortedArrayWith()
مصفوفة تضم عناصر المصفوفة التي استُدعيت عبرها مرتبة وفق المُقارِن المُمرّر comparator
.
sortedBy
تعيد الدالةsortedBy()
لائحة تضم عناصر المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها مرتبة وفقًا للقيم التي تعيدها الدالة المُمرّرة selector
.
sortedByDescending
تعيد الدالةsortedByDescending()
لائحة تضم عناصر المصفوفة أو اللائحة المتغيرة (MutableList
) التي استُدعيت عبرها مرتبة ترتيبًا تنازليًا وفقًا للقيم التي تعيدها الدالة المُمرّرة selector
.
sortedDescending
تعيد الدالةsortedDescending()
لائحة تضم عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها مرتبة تنازليًا.
sortedWith
تعيد الدالةsortedWith()
لائحة تضم عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها مرتبة وفق المُقارِن المُمرّر comparator
.
subtract
تعيد الدالةsubtract()
مجموعة (Set
) تضم عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها والتي لا توجد في المجموعة المُمرّرة.
sum
تعيد الدالةsum()
مجموع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها.
sumBy
تعيد الدالةsumBy()
مجموع العناصر المُعادة من الدالة selector
مطبقةً على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها.
sumByDouble
تعيد الدالةsumByDouble()
مجموع العناصر المُعادة من الدالة selector
مطبقةً على عناصر المصفوفة أو المجموعة التي استُدعيت عبرها.
take
تعيد الدالةtake()
لائحة تضم n
من أولى العناصر الموجودة في المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها.
takeLast
تعيد الدالةtakeLast()
لائحة تضم آخر n
من العناصر الموجودة في المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها.
takeLastWhile
تعيد الدالةtakeLastWhile()
لائحة تضم آخر عناصر المصفوفة أو اللائحة التي استُدعيت عبرها والتي تحقق الشرط المنطقي المُمرّر predicate
.
takeWhile
تعيد الدالةtakeWhile()
لائحة تضم أولى عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها والتي تحقق الشرط المنطقي المُمرّرpredicate
.
toBooleanArray
تعيد الدالةtoBooleanArray()
مصفوفة من القيم المنطقية (من النوع BooleanArray
) تضم جميع عناصر المصفوفة العامة (أي من النوعArray<out Boolean>
) أو المجموعة التي استُدعيت عبرها.
toByteArray
تعيد الدالةtoByteArray()
مصفوفة من النوع ByteArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Byte>
) أو المجموعة التي استُدعيت عبرها.
toCharArray
تعيد الدالةtoCharArray()
مصفوفة من النوع CharArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Char>
) أو المجموعة التي استُدعيت عبرها.
toCollection
تضيف الدالةtoCollection()
عناصر المصفوفة أو المجموعة التي استُدعيت عبرها إلى المجموعة المتغيرة (MutableCollection
) المُمرّرةdestination
.
toDoubleArray
تعيد الدالةtoDoubleArray()
مصفوفة من النوع DoubleArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Double>
) أوالمجموعة التي استُدعيت عبرها.
toFloatArray
تعيد الدالةtoFloatArray()
مصفوفة من النوع FloatArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Float>
) أو المجموعة التي استُدعيت عبرها.
toHashSet
تعيد الدالةtoHashSet()
كائنًا من النوع HashSet
يضم جميع عناصر المصفوفة أو المجموعة التي استُدعيت عبرها.
toIntArray
تعيد الدالةtoIntArray()
مصفوفة من النوع IntArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Int>
) أو المجموعة التي استُدعيت عبرها.
toList
تعيد الدالةtoList()
لائحة تضم جميع عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها. وفي حال استدعاء الدالةtoList()
عبر قاموسفستعيد لائحة تضم جميع الأزواج مفتاح/قيمة المنتمية إليه.
toLongArray
تعيد الدالةtoLongArray()
مصفوفة من النوع LongArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Long>
) أو المجموعة التي استُدعيت عبرها.
toMap
تعيد الدالةtoMap()
قاموسًا بحسب نوع إمضاء الدالة (انظر فقرة البنية العامة من أجل التفاصيل).
toMutableList
تعيد الدالةtoMutableList()
لائحة متغيرة تضم جميع عناصر المصفوف أو المجموعة التي استُدعيت عبرها.
toMutableSet
تعيد الدالةtoMutableSet()
مجموعة من النوع MutableSet
تضم جميع عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها بدون تكرار.
toSet
تعيد الدالةtoSet()
مجموعة من النوع Set
تضم جميع عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها.
toShortArray
تعيد الدالةtoShortArray()
مصفوفة من النوع ShortArray
تضم جميع عناصر المصفوفة العامة (أي من النوع Array<Short>
) أو المجموعة التي استُدعيت عبرها.
toSortedSet
تعيد الدالةtoSortedSet()
مجموعة من النوع SortedSet
تضم جميع عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها. وفي حال تمرير دالة مقارنة comparator
إلى الدالةtoSortedSet()
فسترتب المجموعة المعادة حسب ذلك المقارِن.
union
تعيد الدالةunion()
مجموعة من النوع Set تضم جميع عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها والمجموعة التكرارية المُمرّرة.
unzip
تعيد الدالةunzip()
زوجًا مكونًا من لائحتين، حيث اللائحة الأولي مكونة من العناصر الأولى من كل زوج من المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها، واللائحة الثانية مكونة من العناصر الثانية من كل زوج من المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها.
withIndex
تعيد الدالةwithIndex()
مجموعة تكرارية خاملة (lazy Iterable) من القيم المُفهرسة لكل عنصر من عناصر المصفوفة أو المجموعة التكرارية التي استُدعيت عبرها، وفي حال استدعائها عبر مُكرّر (Iterator
) فستعيد مُكرّرا يغلّف كل عنصر مُنتج من ذلك المكرّر مع القيمة المُفهرسة.
zip
يختلف سلوك الدالةzip()
بحسب إمضائها، أنظر فقرة البنية العامة لأجل التفاصيل.