Kotlin/collections/foldIndexed

تجمع الدالة foldIndexed()‎ ناتج تطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليسار إلى اليمين) المستدعاة معها وفهرس ذلك العنصر بشكل تراكمي بالإضافة إلى القيمة الأولية إن أعطيت.

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

يمكن استدعاء الدالة foldIndexed()‎ مع المصفوفات:

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

ويمكن استدعاؤها مع المجموعات:

inline fun <T, R> Iterable<T>.foldIndexed(
    initial: R, 
    operation: (index: Int, acc: R, T) -> R
): R

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

المعاملات

initial

قيمة أولية يراد إضافتها مع ناتج تطبيق الدالة operation على أول عنصر من عناصر المصفوفة أو المجموعة لبدء عملية التجميع.

operation

دالةٌ تمثل العملية المراد تطبيقها على كل عنصر من عناصر المصفوفة أو المجموعة، إذ يمرَّر إليها فهرس المحرف index والقيمة المجمعة الحالية acc وقيمة كل عنصر من عناصر المصفوفة أو المجموعة T، وتعيد القيمة المجمَّعة التالية acc.

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

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

أمثلة

تعرف الشيفرة الآتية مصفوفة باسم array باستخدام الدالة ()arrayOf ثمَّ تستخدم الدالة ()foldIndexed لتطبيق عملية جمع ناتج ضرب كل عنصر مع قيمة فهرسه تراكميًّا:

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

    val acc = array.foldIndexed(0) { acc, element, index -> acc + element * index }
    print(acc) // 719
}

انظر أيضًا

• الدالة foldRightIndexed()‎: تجمع ناتج تطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليمين إلى اليسار) المستدعاة معها وفهرس ذلك العنصر بشكل تراكمي بالإضافة إلى القيمة الأولية إن أعطيت.  
• الدالة foldRight()‎: تجمع بشكل تراكمي ناتج تطبيق عملية معيَّنة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليمين إلى اليسار) المستدعاة معها والقيمة التراكمية الحالية بالإضافة إلى القيمة الأولية إن أعطيت. 
• الدالة reduceIndexed()‎: ناتج تطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليسار إلى اليمين) المستدعاة معها وفهرس ذلك العنصر بشكل تراكمي والقيمة المجمَّعة الحالية.

مصادر

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