Kotlin/collections/fold

يختلف سلوك الدالةfold()‎ حسب نوع الكائنات التي استُدعيت عبرها و نوع المعاملات (parameters) المُمرّرة إليها (انظر فقرة البنية العامة).

البنية العامة

inline fun <T, R> Array<out T>.fold(
    initial: R, 
    operation: (acc: R, T) -> R
): R 
inline fun <R> ByteArray.fold(
    initial: R, 
    operation: (acc: R, Byte) -> R
): R 
inline fun <R> ShortArray.fold(
    initial: R, 
    operation: (acc: R, Short) -> R
): R 
inline fun <R> IntArray.fold(
    initial: R, 
    operation: (acc: R, Int) -> R
): R 
inline fun <R> LongArray.fold(
    initial: R, 
    operation: (acc: R, Long) -> R
): R 
inline fun <R> FloatArray.fold(
    initial: R, 
    operation: (acc: R, Float) -> R
): R 
inline fun <R> DoubleArray.fold(
    initial: R, 
    operation: (acc: R, Double) -> R
): R 
inline fun <R> BooleanArray.fold(
    initial: R, 
    operation: (acc: R, Boolean) -> R
): R 
inline fun <R> CharArray.fold(
    initial: R, 
    operation: (acc: R, Char) -> R
): R 
inline fun <T, R> Iterable<T>.fold(
    initial: R, 
    operation: (acc: R, T) -> R
): R

تُراكِم الدالةfold()‎ القيم بدءًا من القيمة المُمرّرة initial وتطبّق العملية operation من اليسار إلى اليمين على القيمة المُتراكمة الراهنة وعلى العنصر الموالي في المصفوفة أو المجموعة التي استُدعيت عبرها. ثم تُعيد القيمة النهائية.

inline fun <T, K, R> Grouping<T, K>.fold(
    initialValueSelector: (key: K, element: T) -> R, 
    operation: (key: K, accumulator: R, element: T) -> R
): Map<K, R>

تُجمّع الدالةfold()‎ القيم من المصدر Grouping حسب المفاتيح (keys) وتطبّق العملية operation على عناصر كل مجموعة (group) بشكل متتابع، فتُمرّر قيمة التراكم الراهنة والعنصر الراهن كوسيطين (arguments)، وتخزّن النتائج في قاموس جديد. القيمة الأولية توفّرها الدالة initialValueSelector التي تُزوّد الدالة fold()‎ بقيمة أولية لكل مجموعة (group). ثم تعيد قاموسًا يربط بين مفاتيح كل مجموعة (group) مع نتيجة تراكم عناصرها.

inline fun <T, K, R> Grouping<T, K>.fold(
    initialValue: R, 
    operation: (accumulator: R, element: T) -> R
): Map<K, R>

تُجمّع الدالةfold()‎ القيم من المصدر Grouping حسب المفاتيح (keys) وتطبّق العملية operation على عناصر كل مجموعة (group) بشكل متتابع، فتُمرّر قيمة التراكم الراهنة والعنصر الراهن كوسيطين (arguments)، وتخزّن النتائج في قاموس جديد. القيمة الأولية هي الوسيط الممرّر initialValue. ثم تعيد قاموسًا يربط بين مفاتيح كل مجموعة (group) مع نتيجة تراكم عناصرها.

يُلاحَظ وجود الكلمة المفتاحية inline للدلالة على أن هذه الدالة مباشرة، وللمزيد من التفاصيل راجع توثيق الدوال المباشرة (inline functions).

القيم المٌعادة

انظر فقرة البنية العامة.

أمثلة

استخدام الدالة ()fold مع المصفوفات

تعرف الشيفرة الآتية مصفوفة باسم arrayمكونة من ستة أعداد باستخدام الدالة ()arrayOf، ثم تستخدم الدالة ()fold على array بتمرير القيمة الأوّلية 0 إضافة إلى عملية الإضافة، ثم تطبع الناتج:

fun main(args: Array<String>) {
val array = arrayOf(1,2,3,4,5,6)

val acc = array.fold(0) { sum, element -> sum + element }
print(acc) // 21
}

انظر أيضًا

• foldIndexed()‎: تُراكِم القيم بدءًا من القيمة المُمرّرة initial وتطبّق العملية operation من اليسار إلى اليمين على القيمة المُتراكمة الراهنة وعلى العنصر التالي من المصفوفة أو المجموعة التي استُدعيت عبرها وكذلك فهرسه. وتُعيد القيمة النهائية. 

مصادر

• الدالة  fold()‎ في التوثيق الرسميّ للمكتبة القياسيّة في لغة Kotlin.