From 9f8edc580ad36b72261064ac5efaec833bd388e6 Mon Sep 17 00:00:00 2001 From: Gregory John Casamento Date: Sat, 16 Nov 2024 06:50:58 -0500 Subject: [PATCH 1/2] Add NSUnit documentation --- Headers/Foundation/NSUnit.h | 682 ++++++++++++++++++++++++++++++++---- 1 file changed, 616 insertions(+), 66 deletions(-) diff --git a/Headers/Foundation/NSUnit.h b/Headers/Foundation/NSUnit.h index ba890b3d7..273758ed8 100644 --- a/Headers/Foundation/NSUnit.h +++ b/Headers/Foundation/NSUnit.h @@ -32,14 +32,18 @@ extern "C" { #endif -// Unit converter +/** + * Unit converter + */ GS_EXPORT_CLASS @interface NSUnitConverter : NSObject - (double) baseUnitValueFromValue: (double)value; - (double) valueFromBaseUnitValue: (double)baseUnitValue; @end -// Linea converter... for things like C <-> F conversion... +/** + * Linear converter... for things like C to F conversion... + */ GS_EXPORT_CLASS @interface NSUnitConverterLinear : NSUnitConverter { @@ -53,7 +57,9 @@ GS_EXPORT_CLASS - (double) constant; @end -// Units... abstract... +/** + * Units... abstract... + */ GS_EXPORT_CLASS @interface NSUnit : NSObject { @@ -66,7 +72,9 @@ GS_EXPORT_CLASS @end -// Dimension using units.... +/** + * Dimension using units.... + */ GS_EXPORT_CLASS @interface NSDimension : NSUnit { @@ -81,22 +89,22 @@ GS_EXPORT_CLASS @end // Predefined.... +/** + * Base unit - metersPerSecondSquared + */ GS_EXPORT_CLASS @interface NSUnitAcceleration : NSDimension -/* - Base unit - metersPerSecondSquared - */ + (NSUnitAcceleration *) metersPerSecondSquared; + (NSUnitAcceleration *) gravity; @end +/** + * Base unit - degrees + */ GS_EXPORT_CLASS @interface NSUnitAngle : NSDimension -/* - Base unit - degrees - */ + (NSUnitAngle *) degrees; + (NSUnitAngle *) arcMinutes; @@ -107,11 +115,11 @@ GS_EXPORT_CLASS @end +/** + * Base unit - squareMeters + */ GS_EXPORT_CLASS @interface NSUnitArea : NSDimension -/* - Base unit - squareMeters - */ + (NSUnitArea *) squareMegameters; + (NSUnitArea *) squareKilometers; @@ -130,11 +138,11 @@ GS_EXPORT_CLASS @end +/** + * Base unit - gramsPerLiter + */ GS_EXPORT_CLASS @interface NSUnitConcentrationMass : NSDimension -/* - Base unit - gramsPerLiter - */ + (NSUnitConcentrationMass *) gramsPerLiter; + (NSUnitConcentrationMass *) milligramsPerDeciliter; @@ -143,293 +151,835 @@ GS_EXPORT_CLASS @end +/** + * Units of dispersion. Base unit - partsPerMillion + */ GS_EXPORT_CLASS @interface NSUnitDispersion : NSDimension -/* - Base unit - partsPerMillion + +/** + * Units of dispersion in parts per million. */ + (NSUnitDispersion *) partsPerMillion; @end +/** + * Units of duration. Base unit - seconds + */ GS_EXPORT_CLASS @interface NSUnitDuration : NSDimension -/* - Base unit - seconds - */ +/** + * Units of during in seconds. + */ + (NSUnitDuration *) seconds; + +/** + * Units of during in minutes. + */ + (NSUnitDuration *) minutes; + +/** + * Units of during in hours. + */ + (NSUnitDuration *) hours; @end +/** + * Units of electric charge. Base unit - coulombs + */ GS_EXPORT_CLASS @interface NSUnitElectricCharge : NSDimension -/* - Base unit - coulombs - */ +/** + * The units of eletric charge in coulombs. + */ + (NSUnitElectricCharge *) coulombs; + +/** + * The units of eletric charge in megaampere hours. + */ + (NSUnitElectricCharge *) megaampereHours; + +/** + * The units of eletric charge in kiloampere hours. + */ + (NSUnitElectricCharge *) kiloampereHours; + +/** + * The units of eletric charge in ampere hours. + */ + (NSUnitElectricCharge *) ampereHours; + +/** + * The units of eletric charge in milliampere hours. + */ + (NSUnitElectricCharge *) milliampereHours; + +/** + * The units of eletric charge in microampere hours. + */ + (NSUnitElectricCharge *) microampereHours; @end +/** + * Units of electric current. Base unit - amperes + */ GS_EXPORT_CLASS @interface NSUnitElectricCurrent : NSDimension -/* - Base unit - amperes - */ +/** + * The units of eletric current in megaamperes. + */ + (NSUnitElectricCurrent *) megaamperes; + +/** + * The units of eletric current in kiloamperes. + */ + (NSUnitElectricCurrent *) kiloamperes; + +/** + * The units of eletric current in amperes. + */ + (NSUnitElectricCurrent *) amperes; + +/** + * The units of eletric current in milliamperes. + */ + (NSUnitElectricCurrent *) milliamperes; + +/** + * The units of eletric current in microamperes. + */ + (NSUnitElectricCurrent *) microamperes; @end +/** + * Units of electric potential. Base unit - volts + */ GS_EXPORT_CLASS @interface NSUnitElectricPotentialDifference : NSDimension -/* - Base unit - volts - */ +/** + * The units of eletric potential in megavolts. + */ + (NSUnitElectricPotentialDifference *) megavolts; + +/** + * The units of eletric potential in kilovolts. + */ + (NSUnitElectricPotentialDifference *) kilovolts; + +/** + * The units of eletric potential in volts. + */ + (NSUnitElectricPotentialDifference *) volts; + +/** + * The units of eletric potential in millivolts. + */ + (NSUnitElectricPotentialDifference *) millivolts; + +/** + * The units of eletric potential in microvolts. + */ + (NSUnitElectricPotentialDifference *) microvolts; @end +/** + * Units of electric resistance. Base unit - ohms + */ GS_EXPORT_CLASS @interface NSUnitElectricResistance : NSDimension -/* - Base unit - ohms - */ +/** + * The units of eletric resistance in megaohms. + */ + (NSUnitElectricResistance *) megaohms; + +/** + * The units of eletric resistance in kiloohms. + */ + (NSUnitElectricResistance *) kiloohms; + +/** + * The units of eletric resistance in ohms. + */ + (NSUnitElectricResistance *) ohms; + +/** + * The units of eletric resistance in milliohms. + */ + (NSUnitElectricResistance *) milliohms; + +/** + * The units of eletric resistance in microohms. + */ + (NSUnitElectricResistance *) microohms; @end +/** + * Units of Energy. Base unit - joules + */ GS_EXPORT_CLASS @interface NSUnitEnergy : NSDimension -/* - Base unit - joules - */ +/** + * The units of energy in kilojoules. + */ + (NSUnitEnergy *) kilojoules; + +/** + * The units of energy in joules. + */ + (NSUnitEnergy *) joules; + +/** + * The units of energy in kilocalories. + */ + (NSUnitEnergy *) kilocalories; + +/** + * The units of energy in calories. + */ + (NSUnitEnergy *) calories; + +/** + * The units of energy in kilawatt hours. + */ + (NSUnitEnergy *) kilowattHours; @end +/** + * Units of frequency. Base unit - hertz + */ GS_EXPORT_CLASS @interface NSUnitFrequency : NSDimension -/* - Base unit - hertz - */ +/** + * The units of frequency in terahertz. + */ + (NSUnitFrequency *) terahertz; + +/** + * The units of frequency in gigahertz. + */ + (NSUnitFrequency *) gigahertz; + +/** + * The units of frequency in megahertz. + */ + (NSUnitFrequency *) megahertz; + +/** + * The units of frequency in kilohertz. + */ + (NSUnitFrequency *) kilohertz; + +/** + * The units of frequency in hertz. + */ + (NSUnitFrequency *) hertz; + +/** + * The units of frequency in millihertz. + */ + (NSUnitFrequency *) millihertz; + +/** + * The units of frequency in microhertz. + */ + (NSUnitFrequency *) microhertz; + +/** + * The units of frequency in nanohertz. + */ + (NSUnitFrequency *) nanohertz; @end +/** + * Units of fuel efficiency. Base unit - litersPer100Kilometers + */ GS_EXPORT_CLASS @interface NSUnitFuelEfficiency : NSDimension -/* - Base unit - litersPer100Kilometers - */ +/** + * The units of fuel efficiency in liters per 100 kilometers. + */ + (NSUnitFuelEfficiency *) litersPer100Kilometers; + +/** + * The units of fuel efficiency in miles per imperial gallon. + */ + (NSUnitFuelEfficiency *) milesPerImperialGallon; + +/** + * The units of fuel efficiency in miles per gallon. + */ + (NSUnitFuelEfficiency *) milesPerGallon; @end +/** + * Units of length. Base unit - meters + */ GS_EXPORT_CLASS @interface NSUnitLength : NSDimension -/* - Base unit - meters - */ +/** + * The units of length in megameters. + */ + (NSUnitLength *) megameters; + +/** + * The units of length in kilometers. + */ + (NSUnitLength *) kilometers; + +/** + * The units of length in hectometers. + */ + (NSUnitLength *) hectometers; + +/** + * The units of length in decameters. + */ + (NSUnitLength *) decameters; + +/** + * The units of length in meters. + */ + (NSUnitLength *) meters; + +/** + * The units of length in decimeters. + */ + (NSUnitLength *) decimeters; + +/** + * The units of length in centimeters. + */ + (NSUnitLength *) centimeters; + +/** + * The units of length in millimeters. + */ + (NSUnitLength *) millimeters; + +/** + * The units of length in micrometers. + */ + (NSUnitLength *) micrometers; + +/** + * The units of length in nanometers. + */ + (NSUnitLength *) nanometers; + +/** + * The units of length in picometers. + */ + (NSUnitLength *) picometers; + +/** + * The units of length in inches. + */ + (NSUnitLength *) inches; + +/** + * The units of length in feet. + */ + (NSUnitLength *) feet; + +/** + * The units of length in yards. + */ + (NSUnitLength *) yards; + +/** + * The units of length in miles. + */ + (NSUnitLength *) miles; + +/** + * The units of length in scandanavian miles. + */ + (NSUnitLength *) scandinavianMiles; + +/** + * The units of length in light years. + */ + (NSUnitLength *) lightyears; + +/** + * The units of length in nautical miles. + */ + (NSUnitLength *) nauticalMiles; + +/** + * The units of length in fathoms. + */ + (NSUnitLength *) fathoms; + +/** + * The units of length in furlongs. + */ + (NSUnitLength *) furlongs; + +/** + * The units of length in astronomical units. + */ + (NSUnitLength *) astronomicalUnits; + +/** + * The units of length in parsecs. + */ + (NSUnitLength *) parsecs; @end +/** + * Units of illumination. Base unit - lux + */ GS_EXPORT_CLASS @interface NSUnitIlluminance : NSDimension -/* - Base unit - lux - */ +/** + * The units of illuminance in lux. + */ + (NSUnitIlluminance *) lux; @end +/** + * Units of mass. Base unit - kilograms + */ GS_EXPORT_CLASS @interface NSUnitMass : NSDimension -/* - Base unit - kilograms - */ +/** + * The mass units in kilograms. + */ + (NSUnitMass *) kilograms; + +/** + * The mass units in grams. + */ + (NSUnitMass *) grams; + +/** + * The mass units in decigrams. + */ + (NSUnitMass *) decigrams; + +/** + * The mass units in centigrams. + */ + (NSUnitMass *) centigrams; + +/** + * The mass units in milligrams. + */ + (NSUnitMass *) milligrams; + +/** + * The mass units in micrograms. + */ + (NSUnitMass *) micrograms; + +/** + * The mass units in nanograms. + */ + (NSUnitMass *) nanograms; + +/** + * The mass units in picograms. + */ + (NSUnitMass *) picograms; + +/** + * The mass units in ounces. + */ + (NSUnitMass *) ounces; + +/** + * The mass units in pounds. + */ + (NSUnitMass *) pounds; + +/** + * The mass units in stones. + */ + (NSUnitMass *) stones; + +/** + * The mass units in metric tons. + */ + (NSUnitMass *) metricTons; + +/** + * The mass units in short tons. + */ + (NSUnitMass *) shortTons; + +/** + * The mass units in carats. + */ + (NSUnitMass *) carats; + +/** + * The mass units in ounces troy. + */ + (NSUnitMass *) ouncesTroy; + +/** + * The mass units in slugs. + */ + (NSUnitMass *) slugs; @end +/** + * Used to represent power. Base unit - watts + */ GS_EXPORT_CLASS @interface NSUnitPower : NSDimension -/* - Base unit - watts - */ +/** + * The power units in terawatts. + */ + (NSUnitPower *) terawatts; + +/** + * The power units in gigawatts. + */ + (NSUnitPower *) gigawatts; + +/** + * The power units in megawatts. + */ + (NSUnitPower *) megawatts; + +/** + * The power units in kilowatts. + */ + (NSUnitPower *) kilowatts; + +/** + * The power units in watts. + */ + (NSUnitPower *) watts; + +/** + * The power units in milliwatts. + */ + (NSUnitPower *) milliwatts; + +/** + * The power units in microwatts. + */ + (NSUnitPower *) microwatts; + +/** + * The power units in nanowatts. + */ + (NSUnitPower *) nanowatts; + +/** + * The power units in picowatts. + */ + (NSUnitPower *) picowatts; + +/** + * The power units in femtowatts. + */ + (NSUnitPower *) femtowatts; + +/** + * The power units in horsepower. + */ + (NSUnitPower *) horsepower; @end +/** + * Used to represent pressure. Base unit - newtonsPerMetersSquared (equivalent to 1 pascal) + */ GS_EXPORT_CLASS @interface NSUnitPressure : NSDimension -/* - Base unit - newtonsPerMetersSquared (equivalent to 1 pascal) - */ +/** + * The newtons per meters squared unit of pressure. + */ + (NSUnitPressure *) newtonsPerMetersSquared; + +/** + * The gigapascals unit of pressure. + */ + (NSUnitPressure *) gigapascals; + +/** + * The megapascals unit of pressure. + */ + (NSUnitPressure *) megapascals; + +/** + * The kilopascals unit of pressure. + */ + (NSUnitPressure *) kilopascals; + +/** + * The hetcopascals unit of pressure. + */ + (NSUnitPressure *) hectopascals; + +/** + * The inches of mercury unit of pressure. + */ + (NSUnitPressure *) inchesOfMercury; + +/** + * The bars unit of pressure. + */ + (NSUnitPressure *) bars; + +/** + * The millibars unit of pressure. + */ + (NSUnitPressure *) millibars; + +/** + * The millimeters of mercury of pressure. + */ + (NSUnitPressure *) millimetersOfMercury; + +/** + * The pounds of per square inch of pressure. + */ + (NSUnitPressure *) poundsForcePerSquareInch; @end +/** + * Used to represent speed. Base unit is meters per second. + */ GS_EXPORT_CLASS @interface NSUnitSpeed : NSDimension -/* - Base unit - metersPerSecond - */ +/** + * The meters per second measurement of speed. + */ + (NSUnitSpeed *) metersPerSecond; + +/** + * The kilometers per hour measurement of speed. + */ + (NSUnitSpeed *) kilometersPerHour; + +/** + * The miles per hour measurement of speed. + */ + (NSUnitSpeed *) milesPerHour; + +/** + * The knots measurement of speed. + */ + (NSUnitSpeed *) knots; @end +/** + * Used to represent temperature quantities. + * The base unit of this class is kelvin. + */ GS_EXPORT_CLASS @interface NSUnitTemperature : NSDimension -/* - Base unit - kelvin + +/** + * The kelvin unit of temperature. */ + (NSUnitTemperature *) kelvin; + +/** + * The kelvin unit of celsius. + */ + (NSUnitTemperature *) celsius; -+ (NSUnitTemperature *) fahrenheit; +/** + * The kelvin unit of fahenheit. + */ ++ (NSUnitTemperature *) fahrenheit; @end +/** + * Typically this is used to represent specific quantities. + * The base unit of this class is liters. + */ GS_EXPORT_CLASS @interface NSUnitVolume : NSDimension -/* - Base unit - liters - */ +/** + * The megaliters unit of volume. + */ + (NSUnitVolume *) megaliters; + +/** + * The kiloliters unit of volume. + */ + (NSUnitVolume *) kiloliters; + +/** + * The liters unit of volume. + */ + (NSUnitVolume *) liters; + +/** + * The deciliters unit of volume. + */ + (NSUnitVolume *) deciliters; + +/** + * The centiliters unit of volume. + */ + (NSUnitVolume *) centiliters; + +/** + * The milliliters unit of volume. + */ + (NSUnitVolume *) milliliters; + +/** + * The cubic kilometers unit of volume. + */ + (NSUnitVolume *) cubicKilometers; + +/** + * The cubic meters unit of volume. + */ + (NSUnitVolume *) cubicMeters; + +/** + * The cubic decimeters unit of volume. + */ + (NSUnitVolume *) cubicDecimeters; + +/** + * The cubic centimeteres unit of volume. + */ + (NSUnitVolume *) cubicCentimeters; + +/** + * The cubic millimeters unit of volume. + */ + (NSUnitVolume *) cubicMillimeters; + +/** + * The cubic inches unit of volume. + */ + (NSUnitVolume *) cubicInches; + +/** + * The cubic feet unit of volume. + */ + (NSUnitVolume *) cubicFeet; + +/** + * The cubic yards unit of volume. + */ + (NSUnitVolume *) cubicYards; + +/** + * The cubic miles unit of volume. + */ + (NSUnitVolume *) cubicMiles; + +/** + * The acre feet unit of volume. + */ + (NSUnitVolume *) acreFeet; + +/** + * The bushels unit of volume. + */ + (NSUnitVolume *) bushels; + +/** + * The teaspoons unit of volume. + */ + (NSUnitVolume *) teaspoons; + +/** + * The tablespoons unit of volume. + */ + (NSUnitVolume *) tablespoons; + +/** + * The fluid ounces unit of volume. + */ + (NSUnitVolume *) fluidOunces; + +/** + * The cups unit of volume. + */ + (NSUnitVolume *) cups; + +/** + * The pints unit of volume. + */ + (NSUnitVolume *) pints; + +/** + * The quarts unit of volume. + */ + (NSUnitVolume *) quarts; + +/** + * The gallons unit of volume. + */ + (NSUnitVolume *) gallons; + +/** + * The imperial teaspoons unit of volume. + */ + (NSUnitVolume *) imperialTeaspoons; + +/** + * The imperial tablespoons unit of volume. + */ + (NSUnitVolume *) imperialTablespoons; + +/** + * The imperial fluid ounces unit of volume. + */ + (NSUnitVolume *) imperialFluidOunces; + +/** + * The imperial pints unit of volume. + */ + (NSUnitVolume *) imperialPints; + +/** + * The imperial quarts unit of volume. + */ + (NSUnitVolume *) imperialQuarts; + +/** + * The imperial gallons unit of volume. + */ + (NSUnitVolume *) imperialGallons; + +/** + * The metric cups unit of volume. + */ + (NSUnitVolume *) metricCups; @end From 283cb91ea841428a5c69d51ec0fecb6b7692b915 Mon Sep 17 00:00:00 2001 From: Gregory John Casamento Date: Sat, 16 Nov 2024 07:06:27 -0500 Subject: [PATCH 2/2] Cleanup whitespace --- Headers/Foundation/NSOrderedSet.h | 182 +++++++++++++++--------------- Headers/Foundation/NSUnit.h | 75 ++++++------ 2 files changed, 133 insertions(+), 124 deletions(-) diff --git a/Headers/Foundation/NSOrderedSet.h b/Headers/Foundation/NSOrderedSet.h index ad32006e6..c1c3532fd 100644 --- a/Headers/Foundation/NSOrderedSet.h +++ b/Headers/Foundation/NSOrderedSet.h @@ -38,7 +38,7 @@ #if defined(__cplusplus) extern "C" { #endif - + @class GS_GENERIC_CLASS(NSArray, ElementT); @class GS_GENERIC_CLASS(NSEnumerator, ElementT); @class GS_GENERIC_CLASS(NSSet, ElementT); @@ -54,83 +54,83 @@ GS_EXPORT_CLASS // class methods + (instancetype) orderedSet; -+ (instancetype) orderedSetWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)objects; -+ (instancetype) orderedSetWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)objects - range: (NSRange)range - copyItems:(BOOL)flag; -+ (instancetype) orderedSetWithObject:(GS_GENERIC_TYPE(ElementT))anObject; -+ (instancetype) orderedSetWithObjects:(GS_GENERIC_TYPE(ElementT))firstObject, ...; -+ (instancetype) orderedSetWithObjects:(const GS_GENERIC_TYPE(ElementT)[])objects - count:(NSUInteger) count; -+ (instancetype) orderedSetWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; -+ (instancetype) orderedSetWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; -+ (instancetype) orderedSetWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet - copyItems:(BOOL)flag; ++ (instancetype) orderedSetWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects; ++ (instancetype) orderedSetWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects + range: (NSRange)range + copyItems: (BOOL)flag; ++ (instancetype) orderedSetWithObject: (GS_GENERIC_TYPE(ElementT))anObject; ++ (instancetype) orderedSetWithObjects: (GS_GENERIC_TYPE(ElementT))firstObject, ...; ++ (instancetype) orderedSetWithObjects: (const GS_GENERIC_TYPE(ElementT)[])objects + count: (NSUInteger) count; ++ (instancetype) orderedSetWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; ++ (instancetype) orderedSetWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; ++ (instancetype) orderedSetWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet + copyItems: (BOOL)flag; // instance methods -- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array; -- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array copyItems:(BOOL)flag; -- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array - range:(NSRange)range - copyItems:(BOOL)flag; -- (instancetype) initWithObject:(id)object; -- (instancetype) initWithObjects:(GS_GENERIC_TYPE(ElementT))firstObject, ...; -- (instancetype) initWithObjects:(const GS_GENERIC_TYPE(ElementT)[])objects - count:(NSUInteger)count; -- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; -- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet - copyItems:(BOOL)flag; -- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet - range: (NSRange)range - copyItems:(BOOL)flag; -- (instancetype) initWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; -- (instancetype) initWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet copyItems:(BOOL)flag; +- (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array; +- (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array copyItems: (BOOL)flag; +- (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array + range: (NSRange)range + copyItems: (BOOL)flag; +- (instancetype) initWithObject: (id)object; +- (instancetype) initWithObjects: (GS_GENERIC_TYPE(ElementT))firstObject, ...; +- (instancetype) initWithObjects: (const GS_GENERIC_TYPE(ElementT)[])objects + count: (NSUInteger)count; +- (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; +- (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet + copyItems: (BOOL)flag; +- (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet + range: (NSRange)range + copyItems: (BOOL)flag; +- (instancetype) initWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; +- (instancetype) initWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet copyItems:(BOOL)flag; - (instancetype) init; - (NSUInteger) count; -- (BOOL)containsObject:(GS_GENERIC_TYPE(ElementT))anObject; -- (void) enumerateObjectsAtIndexes:(NSIndexSet *)indexSet - options:(NSEnumerationOptions)opts - usingBlock:(GSEnumeratorBlock)aBlock; +- (BOOL)containsObject: (GS_GENERIC_TYPE(ElementT))anObject; +- (void) enumerateObjectsAtIndexes: (NSIndexSet *)indexSet + options: (NSEnumerationOptions)opts + usingBlock: (GSEnumeratorBlock)aBlock; - (void) enumerateObjectsUsingBlock: (GSEnumeratorBlock)aBlock; -- (void) enumerateObjectsWithOptions:(NSEnumerationOptions)opts - usingBlock:(GSEnumeratorBlock)aBlock; +- (void) enumerateObjectsWithOptions: (NSEnumerationOptions)opts + usingBlock: (GSEnumeratorBlock)aBlock; - (GS_GENERIC_TYPE(ElementT)) firstObject; - (GS_GENERIC_TYPE(ElementT)) lastObject; - (GS_GENERIC_TYPE(ElementT)) objectAtIndex: (NSUInteger)index; - - (GS_GENERIC_TYPE(ElementT)) objectAtIndexedSubscript:(NSUInteger)index; -- (GS_GENERIC_CLASS(NSArray, ElementT)*) objectsAtIndexes:(NSIndexSet *)indexes; -- (NSUInteger) indexOfObject:(GS_GENERIC_TYPE(ElementT))objects; +- (GS_GENERIC_TYPE(ElementT)) objectAtIndexedSubscript: (NSUInteger)index; +- (GS_GENERIC_CLASS(NSArray, ElementT)*) objectsAtIndexes: (NSIndexSet *)indexes; +- (NSUInteger) indexOfObject: (GS_GENERIC_TYPE(ElementT))objects; - (NSUInteger) indexOfObject: (id)key - inSortedRange: (NSRange)range - options: (NSBinarySearchingOptions)options - usingComparator: (NSComparator)comparator; - -- (NSUInteger) indexOfObjectAtIndexes:(NSIndexSet *)indexSet - options:(NSEnumerationOptions)opts - passingTest:(GSPredicateBlock)predicate; -- (NSUInteger) indexOfObjectPassingTest:(GSPredicateBlock)predicate; -- (NSUInteger) indexOfObjectWithOptions:(NSEnumerationOptions)opts - passingTest:(GSPredicateBlock)predicate; -- (NSIndexSet *) indexesOfObjectsAtIndexes:(NSIndexSet *)indexSet - options:(NSEnumerationOptions)opts - passingTest:(GSPredicateBlock)predicate; - -- (NSIndexSet *)indexesOfObjectsPassingTest:(GSPredicateBlock)predicate; -- (NSIndexSet *) indexesOfObjectsWithOptions:(NSEnumerationOptions)opts - passingTest:(GSPredicateBlock)predicate; + inSortedRange: (NSRange)range + options: (NSBinarySearchingOptions)options + usingComparator: (NSComparator)comparator; + +- (NSUInteger) indexOfObjectAtIndexes: (NSIndexSet *)indexSet + options: (NSEnumerationOptions)opts + passingTest: (GSPredicateBlock)predicate; +- (NSUInteger) indexOfObjectPassingTest: (GSPredicateBlock)predicate; +- (NSUInteger) indexOfObjectWithOptions: (NSEnumerationOptions)opts + passingTest: (GSPredicateBlock)predicate; +- (NSIndexSet *) indexesOfObjectsAtIndexes: (NSIndexSet *)indexSet + options: (NSEnumerationOptions)opts + passingTest: (GSPredicateBlock)predicate; + +- (NSIndexSet *)indexesOfObjectsPassingTest: (GSPredicateBlock)predicate; +- (NSIndexSet *) indexesOfObjectsWithOptions: (NSEnumerationOptions)opts + passingTest: (GSPredicateBlock)predicate; - (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) objectEnumerator; - (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) reverseObjectEnumerator; - (NSOrderedSet *)reversedOrderedSet; - (void) getObjects: (__unsafe_unretained GS_GENERIC_TYPE(ElementT)[])aBuffer - range: (NSRange)aRange; + range: (NSRange)aRange; // Key value coding support - (void) setValue: (id)value forKey: (NSString*)key; -- (id) valueForKey: (NSString*)key; +- (id) valueForKey: (NSString*)key; // Comparing Sets - (BOOL) isEqualToOrderedSet: (NSOrderedSet *)aSet; - + // Set operations - (BOOL) intersectsOrderedSet: (NSOrderedSet *)aSet; - (BOOL) intersectsSet: (NSSet *)aSet; @@ -138,12 +138,12 @@ GS_EXPORT_CLASS - (BOOL) isSubsetOfSet:(NSSet *)aSet; // Creating a Sorted Array -- (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingDescriptors:(NSArray *)sortDescriptors; +- (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingDescriptors: (NSArray *)sortDescriptors; - (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingComparator: (NSComparator)comparator; - (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayWithOptions: (NSSortOptions)options - usingComparator: (NSComparator)comparator; + usingComparator: (NSComparator)comparator; // Filtering Ordered Sets - (NSOrderedSet *)filteredOrderedSetUsingPredicate: (NSPredicate *)predicate; @@ -165,42 +165,42 @@ GS_EXPORT_CLASS + (instancetype)orderedSetWithCapacity: (NSUInteger)capacity; - (instancetype)initWithCapacity: (NSUInteger)capacity; - (instancetype) init; -- (void)addObject:(GS_GENERIC_TYPE(ElementT))anObject; -- (void)addObjects:(const GS_GENERIC_TYPE(ElementT)[])objects count:(NSUInteger)count; -- (void)addObjectsFromArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; -- (void)insertObject:(GS_GENERIC_TYPE(ElementT))object atIndex:(NSUInteger)index; -- (void)setObject:(GS_GENERIC_TYPE(ElementT))object atIndexedSubscript:(NSUInteger)index; -- (void)insertObjects:(GS_GENERIC_CLASS(NSArray, ElementT)*)array atIndexes:(NSIndexSet *)indexes; -- (void)removeObject:(GS_GENERIC_TYPE(ElementT))object; -- (void)removeObjectAtIndex:(NSUInteger)index; -- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes; -- (void)removeObjectsInArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; -- (void)removeObjectsInRange:(NSRange)range; +- (void)addObject: (GS_GENERIC_TYPE(ElementT))anObject; +- (void)addObjects: (const GS_GENERIC_TYPE(ElementT)[])objects count: (NSUInteger)count; +- (void)addObjectsFromArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; +- (void)insertObject: (GS_GENERIC_TYPE(ElementT))object atIndex: (NSUInteger)index; +- (void)setObject: (GS_GENERIC_TYPE(ElementT))object atIndexedSubscript: (NSUInteger)index; +- (void)insertObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)array atIndexes: (NSIndexSet *)indexes; +- (void)removeObject: (GS_GENERIC_TYPE(ElementT))object; +- (void)removeObjectAtIndex: (NSUInteger)index; +- (void)removeObjectsAtIndexes: (NSIndexSet *)indexes; +- (void)removeObjectsInArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; +- (void)removeObjectsInRange: (NSRange)range; - (void)removeAllObjects; -- (void)replaceObjectAtIndex:(NSUInteger)index - withObject:(GS_GENERIC_TYPE(ElementT))object; +- (void)replaceObjectAtIndex: (NSUInteger)index + withObject: (GS_GENERIC_TYPE(ElementT))object; - (void) replaceObjectsAtIndexes: (NSIndexSet *)indexes - withObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects; -- (void) replaceObjectsInRange:(NSRange)range - withObjects:(const GS_GENERIC_TYPE(ElementT)[])objects - count: (NSUInteger)count; -- (void)setObject:(GS_GENERIC_TYPE(ElementT))object atIndex:(NSUInteger)index; -- (void)moveObjectsAtIndexes:(NSIndexSet *)indexes toIndex:(NSUInteger)index; -- (void) exchangeObjectAtIndex:(NSUInteger)index withObjectAtIndex:(NSUInteger)otherIndex; -- (void)filterUsingPredicate:(NSPredicate *)predicate; -- (void) sortUsingDescriptors:(NSArray *)descriptors; + withObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects; +- (void) replaceObjectsInRange: (NSRange)range + withObjects: (const GS_GENERIC_TYPE(ElementT)[])objects + count: (NSUInteger)count; +- (void)setObject: (GS_GENERIC_TYPE(ElementT))object atIndex: (NSUInteger)index; +- (void)moveObjectsAtIndexes: (NSIndexSet *)indexes toIndex: (NSUInteger)index; +- (void) exchangeObjectAtIndex: (NSUInteger)index withObjectAtIndex: (NSUInteger)otherIndex; +- (void)filterUsingPredicate: (NSPredicate *)predicate; +- (void) sortUsingDescriptors: (NSArray *)descriptors; - (void) sortUsingComparator: (NSComparator)comparator; - (void) sortWithOptions: (NSSortOptions)options - usingComparator: (NSComparator)comparator; + usingComparator: (NSComparator)comparator; - (void) sortRange: (NSRange)range - options:(NSSortOptions)options + options: (NSSortOptions)options usingComparator: (NSComparator)comparator; -- (void) intersectOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; -- (void) intersectSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; -- (void) minusOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; -- (void) minusSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; -- (void) unionOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; -- (void) unionSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; +- (void) intersectOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; +- (void) intersectSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; +- (void) minusOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; +- (void) minusSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; +- (void) unionOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; +- (void) unionSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; - (instancetype) initWithCoder: (NSCoder *)coder; @end diff --git a/Headers/Foundation/NSUnit.h b/Headers/Foundation/NSUnit.h index 273758ed8..04c3def7a 100644 --- a/Headers/Foundation/NSUnit.h +++ b/Headers/Foundation/NSUnit.h @@ -1,21 +1,21 @@ /** Definition of class NSUnit Copyright (C) 2019 Free Software Foundation, Inc. - + By: Gregory John Casamento Date: Mon Sep 30 15:58:21 EDT 2019 This file is part of the GNUstep Library. - + 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 of the License, or (at your option) any later version. - + 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 library; if not, write to the Free Software Foundation, Inc., 31 Milk Street #960789 Boston, MA 02196 USA. @@ -52,7 +52,7 @@ GS_EXPORT_CLASS } - (instancetype) initWithCoefficient: (double)coefficient; - (instancetype) initWithCoefficient: (double)coefficient - constant: (double)constant; + constant: (double)constant; - (double) coefficient; - (double) constant; @end @@ -65,7 +65,7 @@ GS_EXPORT_CLASS { NSString *_symbol; } - + - (instancetype) init; - (instancetype) initWithSymbol: (NSString *)symbol; - (NSString *) symbol; @@ -93,7 +93,7 @@ GS_EXPORT_CLASS * Base unit - metersPerSecondSquared */ GS_EXPORT_CLASS -@interface NSUnitAcceleration : NSDimension +@interface NSUnitAcceleration : NSDimension + (NSUnitAcceleration *) metersPerSecondSquared; + (NSUnitAcceleration *) gravity; @@ -104,7 +104,7 @@ GS_EXPORT_CLASS * Base unit - degrees */ GS_EXPORT_CLASS -@interface NSUnitAngle : NSDimension +@interface NSUnitAngle : NSDimension + (NSUnitAngle *) degrees; + (NSUnitAngle *) arcMinutes; @@ -119,7 +119,7 @@ GS_EXPORT_CLASS * Base unit - squareMeters */ GS_EXPORT_CLASS -@interface NSUnitArea : NSDimension +@interface NSUnitArea : NSDimension + (NSUnitArea *) squareMegameters; + (NSUnitArea *) squareKilometers; @@ -139,14 +139,24 @@ GS_EXPORT_CLASS @end /** - * Base unit - gramsPerLiter + * Units of concentration. Base unit - gramsPerLiter. */ GS_EXPORT_CLASS -@interface NSUnitConcentrationMass : NSDimension +@interface NSUnitConcentrationMass : NSDimension +/** + * Concentration units in grams per liter. + */ + (NSUnitConcentrationMass *) gramsPerLiter; + +/** + * Concentration units in milligrams per deciliter. + */ + (NSUnitConcentrationMass *) milligramsPerDeciliter; +/** + * Concentration units in grams per mole. + */ + (NSUnitConcentrationMass *) millimolesPerLiterWithGramsPerMole: (double)gramsPerMole; @end @@ -155,7 +165,7 @@ GS_EXPORT_CLASS * Units of dispersion. Base unit - partsPerMillion */ GS_EXPORT_CLASS -@interface NSUnitDispersion : NSDimension +@interface NSUnitDispersion : NSDimension /** * Units of dispersion in parts per million. @@ -168,20 +178,20 @@ GS_EXPORT_CLASS * Units of duration. Base unit - seconds */ GS_EXPORT_CLASS -@interface NSUnitDuration : NSDimension +@interface NSUnitDuration : NSDimension /** - * Units of during in seconds. + * Units of duration in seconds. */ + (NSUnitDuration *) seconds; /** - * Units of during in minutes. + * Units of duration in minutes. */ + (NSUnitDuration *) minutes; /** - * Units of during in hours. + * Units of duration in hours. */ + (NSUnitDuration *) hours; @@ -191,7 +201,7 @@ GS_EXPORT_CLASS * Units of electric charge. Base unit - coulombs */ GS_EXPORT_CLASS -@interface NSUnitElectricCharge : NSDimension +@interface NSUnitElectricCharge : NSDimension /** * The units of eletric charge in coulombs. @@ -229,7 +239,7 @@ GS_EXPORT_CLASS * Units of electric current. Base unit - amperes */ GS_EXPORT_CLASS -@interface NSUnitElectricCurrent : NSDimension +@interface NSUnitElectricCurrent : NSDimension /** * The units of eletric current in megaamperes. @@ -262,7 +272,7 @@ GS_EXPORT_CLASS * Units of electric potential. Base unit - volts */ GS_EXPORT_CLASS -@interface NSUnitElectricPotentialDifference : NSDimension +@interface NSUnitElectricPotentialDifference : NSDimension /** * The units of eletric potential in megavolts. @@ -295,7 +305,7 @@ GS_EXPORT_CLASS * Units of electric resistance. Base unit - ohms */ GS_EXPORT_CLASS -@interface NSUnitElectricResistance : NSDimension +@interface NSUnitElectricResistance : NSDimension /** * The units of eletric resistance in megaohms. @@ -328,7 +338,7 @@ GS_EXPORT_CLASS * Units of Energy. Base unit - joules */ GS_EXPORT_CLASS -@interface NSUnitEnergy : NSDimension +@interface NSUnitEnergy : NSDimension /** * The units of energy in kilojoules. @@ -361,7 +371,7 @@ GS_EXPORT_CLASS * Units of frequency. Base unit - hertz */ GS_EXPORT_CLASS -@interface NSUnitFrequency : NSDimension +@interface NSUnitFrequency : NSDimension /** * The units of frequency in terahertz. @@ -409,7 +419,7 @@ GS_EXPORT_CLASS * Units of fuel efficiency. Base unit - litersPer100Kilometers */ GS_EXPORT_CLASS -@interface NSUnitFuelEfficiency : NSDimension +@interface NSUnitFuelEfficiency : NSDimension /** * The units of fuel efficiency in liters per 100 kilometers. @@ -432,7 +442,7 @@ GS_EXPORT_CLASS * Units of length. Base unit - meters */ GS_EXPORT_CLASS -@interface NSUnitLength : NSDimension +@interface NSUnitLength : NSDimension /** * The units of length in megameters. @@ -550,7 +560,7 @@ GS_EXPORT_CLASS * Units of illumination. Base unit - lux */ GS_EXPORT_CLASS -@interface NSUnitIlluminance : NSDimension +@interface NSUnitIlluminance : NSDimension /** * The units of illuminance in lux. @@ -563,7 +573,7 @@ GS_EXPORT_CLASS * Units of mass. Base unit - kilograms */ GS_EXPORT_CLASS -@interface NSUnitMass : NSDimension +@interface NSUnitMass : NSDimension /** * The mass units in kilograms. @@ -651,7 +661,7 @@ GS_EXPORT_CLASS * Used to represent power. Base unit - watts */ GS_EXPORT_CLASS -@interface NSUnitPower : NSDimension +@interface NSUnitPower : NSDimension /** * The power units in terawatts. @@ -714,7 +724,7 @@ GS_EXPORT_CLASS * Used to represent pressure. Base unit - newtonsPerMetersSquared (equivalent to 1 pascal) */ GS_EXPORT_CLASS -@interface NSUnitPressure : NSDimension +@interface NSUnitPressure : NSDimension /** * The newtons per meters squared unit of pressure. @@ -772,7 +782,7 @@ GS_EXPORT_CLASS * Used to represent speed. Base unit is meters per second. */ GS_EXPORT_CLASS -@interface NSUnitSpeed : NSDimension +@interface NSUnitSpeed : NSDimension /** * The meters per second measurement of speed. @@ -801,7 +811,7 @@ GS_EXPORT_CLASS * The base unit of this class is kelvin. */ GS_EXPORT_CLASS -@interface NSUnitTemperature : NSDimension +@interface NSUnitTemperature : NSDimension /** * The kelvin unit of temperature. @@ -811,7 +821,7 @@ GS_EXPORT_CLASS /** * The kelvin unit of celsius. */ -+ (NSUnitTemperature *) celsius; ++ (NSUnitTemperature *) celsius; /** * The kelvin unit of fahenheit. @@ -825,7 +835,7 @@ GS_EXPORT_CLASS * The base unit of this class is liters. */ GS_EXPORT_CLASS -@interface NSUnitVolume : NSDimension +@interface NSUnitVolume : NSDimension /** * The megaliters unit of volume. @@ -991,4 +1001,3 @@ GS_EXPORT_CLASS #endif /* GS_API_MACOSX */ #endif /* _NSUnit_h_GNUSTEP_BASE_INCLUDE */ -