/*
 * Copyright (c) 2026 University of Insubria <https://www.uninsubria.it>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version. All we ask is that proper credit is given
 * for our work, which includes - but is not limited to - adding the above
 * copyright notice to the beginning of your source code files, and to any
 * copyright notice that you may distribute with programs based on this work.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.
 * <https://fsf.org/>
 */

package qsardes.descriptor.qsarwb;

import org.openscience.cdk.interfaces.IAtom;
import org.openscience.cdk.interfaces.IAtomContainer;
import qsardes.descriptor.DescriptorInformationContent;

/**
 * Information content descriptors (QSAR-WB Descriptors).
 * <BR><BR>
 * Calculates information content descriptors.
 * <BR><BR>
 * Returns
 * <BR><BR>
 * IC# - Information content index.
 * <BR>
 * TIC# - Total information content index.
 * <BR>
 * SIC# - Structural information content index.
 * <BR>
 * CIC# - Complementary information content index.
 * <BR>
 * BIC# - Bond information content index.
 * <BR>
 * MIC# - Modified information content index.
 * <BR>
 * ZMIC# - Z-modified information content index.
 * <BR><BR>
 * # is the order of the neighborhood symmetry.
 *
 * @author Nicola Chirico
 */
public final class QsarWBInformationContent
        extends DescriptorInformationContent
{
    public QsarWBInformationContent()
    {
    }

    @Override
    protected String get_aromatic_info(IAtomContainer iac, IAtom atom_p,
            IAtom atom_i)
    {
        return iac.getBond(atom_p, atom_i).isAromatic()
                ? "A" : String.valueOf(iac.getBond(atom_p, atom_i)
                        .getOrder().numeric());
    }
}
